RecordReaderRegion

Range that allows reading a record based format via tabix. Needs a record type that encompasses only one line of text and a ChromInterval region to use for tabix filtering. Rectype could be GFF3Record, BedRecord ... This is a sister struct to dhtslib.bgzf.RecordReader.

struct RecordReaderRegion (

RecType

CoordSystem cs

) {

TabixIndexedFile file;

ReturnType!(this.initializeRange) range;

string chrom;

Interval!cs coords;

string header;

bool emptyLine;

this(string fn, string chrom, Interval!cs coords, string fnIdx);

auto initializeRange();

RecType front();

void popFront();

auto empty();

typeof(this) save();

}

Constructors

this this(string fn, string chrom, Interval!cs coords, string fnIdx): string chrom and Interval ctor

Members

Functions

empty auto empty(): is the range done
front RecType front(): returns RecType
initializeRange auto initializeRange(): copy the TabixIndexedFile.region range
popFront void popFront(): move the range
save typeof(this) save(): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

chrom string chrom;: chrom of region
coords Interval!cs coords;: coordinates of region
emptyLine bool emptyLine;: Undocumented in source.
file TabixIndexedFile file;: file reader
header string header;: keep the header
range ReturnType!(this.initializeRange) range;: file reader range

RecordReaderRegion

Constructors

Members

Functions

Variables

Meta

Source