Class/Object

io.projectglow.bgen

BgenRecordWriter

Related Docs: object BgenRecordWriter | package bgen

Permalink

class BgenRecordWriter extends GlowLogging

Writes BGEN records.

Linear Supertypes
GlowLogging, LazyLogging, LazyLogging, Logging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BgenRecordWriter
  2. GlowLogging
  3. LazyLogging
  4. LazyLogging
  5. Logging
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BgenRecordWriter(outputStream: OutputStream, schema: StructType, writeHeader: Boolean, numVariants: Long, bitsPerProb: Int, maxPloidy: Int, defaultPloidy: Int, defaultPhasing: Boolean)

    Permalink

    outputStream

    The output stream to write to

    schema

    Schema of the input rows

    writeHeader

    If true, write the header

    numVariants

    Number of variants (for the header)

    bitsPerProb

    Number of bits used to represent each genotype/haplotype probability value

    maxPloidy

    If ploidy is missing, it is inferred as some value in [1, maxPloidy]

    defaultPloidy

    If phasing and ploidy are missing or the inferred ploidy is ambiguous, we assume ploidy is defaultPloidy

    defaultPhasing

    If phasing is missing and the inferred phasing is ambiguous, we assume phasing is defaultPhasing

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. val buffSize: Int

    Permalink
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def close(): Unit

    Permalink
  8. val converter: InternalRowToBgenRowConverter

    Permalink
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def getCompressedGenotypeProbabilityData(row: BgenRow): (Int, Array[Byte])

    Permalink

    # Bytes | Description

    # Bytes | Description

    +

    4 | Number of samples ----------------------------------------------------------------------------------------------- 2 | Number of alleles ----------------------------------------------------------------------------------------------- 1 | Minimum ploidy of samples ----------------------------------------------------------------------------------------------- 1 | Maximum ploidy of samples ----------------------------------------------------------------------------------------------- N | The nth byte represents the ploidy and missingness of the nth sample. Ploidy is | encoded in the least significant 6 bits of this value. Missingness is encoded by the | most significant bit (1 if missing). ----------------------------------------------------------------------------------------------- 1 | 1 if phased, 0 if unphased ----------------------------------------------------------------------------------------------- 1 | Number of bits used to store each probability = B ----------------------------------------------------------------------------------------------- X | Probabilities for each possible haplotype (if phased)/genotype (if unphased) -----------------------------------------------------------------------------------------------

  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  15. var headerHasBeenWritten: Boolean

    Permalink
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging → Logging
  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. val probBlockSizeMap: HashMap[GenotypeCharacteristics, ProbabilityBlockSize]

    Permalink
  22. val probabilityWriter: (Long, LittleEndianDataOutputStream) ⇒ Unit

    Permalink
  23. val stream: LittleEndianDataOutputStream

    Permalink
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  25. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def write(row: InternalRow): Unit

    Permalink

    A Bgen file consists of a header followed by M variant data blocks.

    A Bgen file consists of a header followed by M variant data blocks. Variant data blocks consist of: - Variant identifying data - Genotype data block

  30. def writeGenotypeDataBlock(row: BgenRow): Unit

    Permalink

    # Bytes | Description

    # Bytes | Description

    +

    4 | Total length of the the rest of the data for this variant = C -------------------------------------------------------------------------------------- 4 | Total length of the probability data after decompression = D -------------------------------------------------------------------------------------- C-4 | Genotype probability data for each of the N samples: decompressed to D bytes --------------------------------------------------------------------------------------

Inherited from GlowLogging

Inherited from LazyLogging

Inherited from LazyLogging

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped