Function
readRecord
reads one record (e.g. a single DNA-sequence and its meta data) from a StreamConcept, by the means of RecordReader
Include Headers
seqan/bam_io.h, seqan/stream.h
Parameters
possibly multiple fields (e.g. meta and sequence) | |
The reader object to read from Types: RecordReader | |
The file format tag | |
The RecordReader to read from. Types: RecordReader Remarks: Use for SAM. | |
BamHeader to read information into. Types: BamHeader | |
The context to use for reading. Types: BamIOContext | |
The stream to read from (for BAM). Types: StreamConcept Remarks: BAM data can be read from any stream. For the proper decompression (from compressed BAM, the default) use BGZF Stream. | |
Format to read BamHeader from. | |
Types: BamAlignmentRecord |
Remarks
If not noted otherwise, only a Single-Pass implementation is available for a the given format
For FASTA-Files a double-Pass implementation of RecordReader is implemented, which offers better performance. Just pass a Double-Pass reader object (only works with seekable Streams).
For FASTQ-Files a double-Pass implementation of RecordReader is implemented, which offers better performance. Just pass a Double-Pass reader object (only works with seekable Streams).
Member of
See Also
SeqAn - Sequence Analysis Library - www.seqan.de