BioKotlin/biokotlin.util/VCFReader

VCFReader

data class VCFReader(val filename: String, val altHeaders: Map<String, AltHeaderMetaData>, val samples: List<String>, variants: Channel<Deferred<LinkedList<SimpleVariant>>>, scope: CoroutineScope = CoroutineScope(Dispatchers.Default))

Constructors

VCFReader

constructor(filename: String, altHeaders: Map<String, AltHeaderMetaData>, samples: List<String>, variants: Channel<Deferred<LinkedList<SimpleVariant>>>, scope: CoroutineScope = CoroutineScope(Dispatchers.Default))

Properties

altHeaders

val altHeaders: Map<String, AltHeaderMetaData>

filename

val filename: String

samples

val samples: List<String>

Functions

advanceVariant

suspend fun advanceVariant()

Function to advance to the next variant in the VCF file. Use this in conjunction with variant() to get the next variant.

variant

suspend fun variant(): SimpleVariant?

Function to get the current variant in the VCF file. This doesn't advance to the next variant. Every call to this function will return the same variant until advanceVariant is called. Returns null if there are no more variants for this reader.