cljam.io.protocols

Protocols of reader/writer for various file formats.

IAlignmentReader

protocol

members

read-alignments

(read-alignments this)(read-alignments this region)
Reads alignments of the SAM/BAM file, returning the alignments as an eduction.

read-blocks

(read-blocks this)(read-blocks this region)(read-blocks this region option)
Reads alignment blocks of the SAM/BAM file, returning the blocks as an eduction.

read-header

(read-header this)
Returns header of the SAM/BAM file.

read-refs

(read-refs this)
Returns references of the SAM/BAM file.

IAlignmentWriter

protocol

members

write-alignments

(write-alignments this alignments header)
Writes alignments to the SAM/BAM file.

write-blocks

(write-blocks this blocks)
Writes alignment blocks of the SAM/BAM file.

write-header

(write-header this header)
Writes header to the SAM/BAM file.

write-refs

(write-refs this header)
Writes references to the SAM/BAM file.

IReader

protocol

members

indexed?

(indexed? this)
Returns true if the reader can be randomly accessed, false if not.

read

(read this)(read this option)
Sequentially reads contents of the file.

reader-url

(reader-url this)
Returns the file's URL.

IRegionReader

protocol

members

read-in-region

(read-in-region this region)(read-in-region this region option)
Reads contents of the file in given region.

ISequenceReader

protocol

members

read-all-sequences

(read-all-sequences this)(read-all-sequences this option)
Reads all sequences of FASTA/2BIT file.

read-indices

(read-indices this)
Reads metadata of indexed sequences in FASTA/2BIT file.

read-seq-summaries

(read-seq-summaries this)
Reads summaries of sequences in the file.

read-sequence

(read-sequence this region)(read-sequence this region option)
Reads sequence in region of FASTA/2BIT file.

ISequenceWriter

protocol

members

write-sequences

(write-sequences this seqs)
Writes all sequences to FASTA/2BIT file.

IVariantReader

protocol

members

header

(header this)
Returns header of VCF/BCF file as a sequence of strings.

meta-info

(meta-info this)
Returns meta-info section of VCF/BCF file as a map.

read-file-offsets

(read-file-offsets rdr)
Reads file-offsets of VCF/BCF file

read-variants

(read-variants this)(read-variants this option)
Reads variants of the VCF/BCF file, returning them as a lazy sequence.

read-variants-randomly

(read-variants-randomly this region-option depth-option)
Reads randomly variants of the VCF/BCF file, returning them as a lazy sequence.

IVariantWriter

protocol

members

write-variants

(write-variants this variants)
Writes variants to thee VCF/BCF file.

IWriter

protocol

members

writer-url

(writer-url this)
Returns the source's URL.