BAMFormatter.Format Method (Stream, BAMIndexStorage, ISequenceAlignment)

BAMFormatterFormat Method (Stream, BAMIndexStorage, ISequenceAlignment)

Writes specified alignment object to a stream. The output is formatted according to the BAM specification.

Namespace: Bio.IO.BAM
Assembly: Bio.Core (in Bio.Core.dll) Version: 2.0.0.1 (2.0.0.1)

Syntax

public void Format(
	Stream writer,
	BAMIndexStorage indexWriter,
	ISequenceAlignment sequenceAlignment
)

Public Sub Format ( 
	writer As Stream,
	indexWriter As BAMIndexStorage,
	sequenceAlignment As ISequenceAlignment
)

public:
void Format(
	Stream^ writer, 
	BAMIndexStorage^ indexWriter, 
	ISequenceAlignment^ sequenceAlignment
)

member Format : 
        writer : Stream * 
        indexWriter : BAMIndexStorage * 
        sequenceAlignment : ISequenceAlignment -> unit

writer: Type: System.IOStream
Stream to write BAM data.
indexWriter: Type: Bio.IO.BAMBAMIndexStorage
BAMIndexFile to write index data.
sequenceAlignment: Type: Bio.Algorithms.AlignmentISequenceAlignment
SequenceAlignmentMap object.