org.hammerlab.genomics.readsets.io

InputConfig

case class InputConfig(overlapsLociOpt: Option[ParsedLoci], nonDuplicate: Boolean, passedVendorQualityChecks: Boolean, isPaired: Boolean, minAlignmentQualityOpt: Option[Int], maxSplitSizeOpt: Option[Long]) extends Product with Serializable

Configuring how/which reads are loaded can be an important optimization.

Most of these fields are commonly used filters. For boolean fields, setting a field to true will result in filtering on that field. The result is the intersection of the filters (i.e. reads must satisfy ALL filters).

overlapsLociOpt

if set, include only mapped reads that overlap the given loci

nonDuplicate

include only reads that do not have the duplicate bit set

passedVendorQualityChecks

include only reads that do not have the failedVendorQualityChecks bit set

isPaired

include only reads are paired-end reads

minAlignmentQualityOpt

Minimum Phred-scaled alignment score for a read

maxSplitSizeOpt

Maximum on-disk size to allow Hadoop splits to be; useful to set below the on-disk block-size for BAMs where the reads compress extra-well, resulting in unwieldy numbers of reads per fixed-disk-size partition.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. InputConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new InputConfig(overlapsLociOpt: Option[ParsedLoci], nonDuplicate: Boolean, passedVendorQualityChecks: Boolean, isPaired: Boolean, minAlignmentQualityOpt: Option[Int], maxSplitSizeOpt: Option[Long])

    overlapsLociOpt

    if set, include only mapped reads that overlap the given loci

    nonDuplicate

    include only reads that do not have the duplicate bit set

    passedVendorQualityChecks

    include only reads that do not have the failedVendorQualityChecks bit set

    isPaired

    include only reads are paired-end reads

    minAlignmentQualityOpt

    Minimum Phred-scaled alignment score for a read

    maxSplitSizeOpt

    Maximum on-disk size to allow Hadoop splits to be; useful to set below the on-disk block-size for BAMs where the reads compress extra-well, resulting in unwieldy numbers of reads per fixed-disk-size partition.

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  12. val isPaired: Boolean

    include only reads are paired-end reads

  13. def loci: ParsedLoci

  14. val maxSplitSizeOpt: Option[Long]

    Maximum on-disk size to allow Hadoop splits to be; useful to set below the on-disk block-size for BAMs where the reads compress extra-well, resulting in unwieldy numbers of reads per fixed-disk-size partition.

  15. val minAlignmentQualityOpt: Option[Int]

    Minimum Phred-scaled alignment score for a read

  16. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. val nonDuplicate: Boolean

    include only reads that do not have the duplicate bit set

  18. final def notify(): Unit

    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  20. val overlapsLociOpt: Option[ParsedLoci]

    if set, include only mapped reads that overlap the given loci

  21. val passedVendorQualityChecks: Boolean

    include only reads that do not have the failedVendorQualityChecks bit set

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

    Definition Classes
    AnyRef
  23. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped