Package htsjdk.tribble.index.tabix
Class TabixFormat
java.lang.Object
htsjdk.tribble.index.tabix.TabixFormat
- All Implemented Interfaces:
Cloneable
The values in a Tabix header that define the format of the file being indexed, e.g. gff, bed, vcf
-
Field Summary
Modifier and TypeFieldDescriptionstatic final TabixFormat
int
One-based index of the column in the file being indexed containing the end position.int
Describes interpretation of file being indexed.static final int
static final TabixFormat
Predefined headers for known formatschar
Lines in the file being indexed that start with this character are ignored.int
TODO: This is written, and part of the index header, but does not appear to be used.static final TabixFormat
static final TabixFormat
static final int
int
One-based index of the column in the file being indexed containing the sequence nameint
One-based index of the column in the file being indexed containing the start position.static final int
static final TabixFormat
static final int
static final int
-
Constructor Summary
ConstructorDescriptionTabixFormat
(int flags, int sequenceColumn, int startPositionColumn, int endPositionColumn, char metaCharacter, int numHeaderLinesToSkip) -
Method Summary
-
Field Details
-
ZERO_BASED
public static final int ZERO_BASED- See Also:
-
GENERIC_FLAGS
public static final int GENERIC_FLAGS- See Also:
-
SAM_FLAGS
public static final int SAM_FLAGS- See Also:
-
VCF_FLAGS
public static final int VCF_FLAGS- See Also:
-
UCSC_FLAGS
public static final int UCSC_FLAGS- See Also:
-
GFF
Predefined headers for known formats -
BED
-
PSLTBL
-
SAM
-
VCF
-
flags
public int flagsDescribes interpretation of file being indexed. See FLAGS constants above. -
sequenceColumn
public int sequenceColumnOne-based index of the column in the file being indexed containing the sequence name -
startPositionColumn
public int startPositionColumnOne-based index of the column in the file being indexed containing the start position. -
endPositionColumn
public int endPositionColumnOne-based index of the column in the file being indexed containing the end position. Zero implies there is no end position column. -
metaCharacter
public char metaCharacterLines in the file being indexed that start with this character are ignored. -
numHeaderLinesToSkip
public int numHeaderLinesToSkipTODO: This is written, and part of the index header, but does not appear to be used.
-
-
Constructor Details
-
TabixFormat
public TabixFormat() -
TabixFormat
public TabixFormat(int flags, int sequenceColumn, int startPositionColumn, int endPositionColumn, char metaCharacter, int numHeaderLinesToSkip)
-
-
Method Details