org.bdgenomics.avocado.util

PrefilterReads

object PrefilterReads extends Serializable

Reifies an input AlignmentRecordRDD down to the contigs and reads we want to genotype.

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

Value Members

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

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

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

    Definition Classes
    AnyRef → Any
  4. def apply(rdd: AlignmentRecordRDD, args: PrefilterReadsArgs): AlignmentRecordRDD

    Filters out reads and contigs that should not be processed.

    Filters out reads and contigs that should not be processed.

    rdd

    RDD of reads and associated metadata.

    args

    Arguments specifying the filters to apply.

    returns

    Returns a new AlignmentRecordRDD where reads that we don't want to use in genotyping have been discarded, and where contigs that we don't want to genotype have been removed.

  5. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  6. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def contigFilterFn(args: PrefilterReadsArgs): (String) ⇒ Boolean

    args

    The arguments specifying which contigs to keep.

    returns

    Returns a function that returns true if a contig with a given name should be kept.

    Attributes
    protected[org.bdgenomics.avocado.util]
  8. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  10. def filterGrcAutosome(contigName: String): Boolean

    contigName

    Contig name to test for filtration.

    returns

    Returns true if the contig matches the naming scheme for GRCh autosomal chromosomes.

    Attributes
    protected[org.bdgenomics.avocado.util]
  11. def filterGrcMitochondrial(contigName: String): Boolean

    contigName

    Contig name to test for filtration.

    returns

    Returns true if the contig matches the GRCh mitochondrial chromosome name.

    Attributes
    protected[org.bdgenomics.avocado.util]
  12. def filterGrcSex(contigName: String): Boolean

    contigName

    Contig name to test for filtration.

    returns

    Returns true if the contig matches the naming scheme for GRCh sex chromosomes.

    Attributes
    protected[org.bdgenomics.avocado.util]
  13. def filterMapped(read: AlignmentRecord, keepNonPrimary: Boolean): Boolean

    read

    Read to test for filtration.

    returns

    Returns true if the read is aligned.

    Attributes
    protected[org.bdgenomics.avocado.util]
  14. def filterMappingQuality(read: AlignmentRecord, minMappingQuality: Int): Boolean

    read

    Read to test for filtration.

    minMappingQuality

    Only keep reads with a mapping quality above this value.

    returns

    Returns true if the read is aligned.

    Attributes
    protected[org.bdgenomics.avocado.util]
  15. def filterNonGrcAutosome(contigName: String): Boolean

    contigName

    Contig name to test for filtration.

    returns

    Returns true if the contig matches the naming scheme for HG/UCSC autosomal chromosomes.

    Attributes
    protected[org.bdgenomics.avocado.util]
  16. def filterNonGrcMitochondrial(contigName: String): Boolean

    contigName

    Contig name to test for filtration.

    returns

    Returns true if the contig matches the HG/UCSC mitochondrial chromosome name.

    Attributes
    protected[org.bdgenomics.avocado.util]
  17. def filterNonGrcSex(contigName: String): Boolean

    contigName

    Contig name to test for filtration.

    returns

    Returns true if the contig matches the naming scheme for HG/UCSC sex chromosomes.

    Attributes
    protected[org.bdgenomics.avocado.util]
  18. def filterUnique(read: AlignmentRecord): Boolean

    read

    Read to test for filtration.

    returns

    Returns true if the read is not a duplicate read.

    Attributes
    protected[org.bdgenomics.avocado.util]
  19. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

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

    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  24. final def notify(): Unit

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

    Definition Classes
    AnyRef
  26. def readFilterFn(args: PrefilterReadsArgs, contigFilterFn: (String) ⇒ Boolean): (AlignmentRecord) ⇒ Boolean

    args

    The arguments specifying which reads to keep.

    contigFilterFn

    A function that determines which contigs should be kept, given the contig name.

    returns

    Returns a function that returns true if a read should be kept.

    Attributes
    protected[org.bdgenomics.avocado.util]
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  28. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped