object UmiConsensusCaller

Contains shared types and functions used when writing UMI-driven consensus callers that take in SamRecords and emit SamRecords.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UmiConsensusCaller
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait SimpleRead extends AnyRef

    A trait that consensus reads must implement.

  2. case class SourceRead(id: String, bases: Array[Byte], quals: Array[Byte], cigar: Cigar, sam: Option[SamRecord] = None) extends SimpleRead with Product with Serializable

    Stores information about a read to be fed into a consensus.

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. val FilterInsufficientSupport: String

    Filter reason for when there are too few reads to form a consensus.

  5. val FilterLowQuality: String

    Filter reason for when reads are rejected due to low quality.

  6. val FilterMinorityAlignment: String

    Filter reason for when reads are rejected for having a minority CIGAR.

  7. val FilterOrphan: String

    Filter reason for when reads are rejected due creation of orphaned consensus (i.e.

    Filter reason for when reads are rejected due creation of orphaned consensus (i.e. R1 or R2 failed).

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def checkSortOrder(header: SAMFileHeader, source: Any, warn: (String) ⇒ Unit, error: (String) ⇒ Unit): Unit

    Helper method to check that the input BAM is in the correct order for consensus calling.

    Helper method to check that the input BAM is in the correct order for consensus calling. Will call the warn function if the sort order looks like it's probably compatible but it's not 100% sure. Will invoke the error function in cases where the sort order is definitely incompatible.

    header

    the header of the BAM file to be used for consensus calling

    source

    a path or string representing the source of the header

    warn

    a function to be called when any warnings are detected/emitted

    error

    a function to be called when any errors are encountered; should probably throw an exception!

  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def makePrefixFromSamHeader(header: SAMFileHeader): String

    Attempts to construct a String that can be used as a prefix for consensus read names based on the contents of the incoming SAMFileHeader.

  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def outputHeader(in: SAMFileHeader, readGroupId: String, sortOrder: Option[SamOrder] = None): SAMFileHeader

    Constructs an output header with a single read group for the a BAM.

  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. object ReadType extends Enumeration

    The type of consensus read to output.

Inherited from AnyRef

Inherited from Any

Ungrouped