Class

org.hammerlab.genomics.reads

MappedRead

Related Doc: package reads

Permalink

case class MappedRead(name: String, sequence: Bases, baseQualities: IndexedSeq[Byte], isDuplicate: Boolean, contigName: ContigName, alignmentQuality: Int, start: Locus, cigar: Cigar, failedVendorQualityChecks: Boolean, isPositiveStrand: Boolean, isPaired: Boolean) extends Read with Region with Product with Serializable

A mapped read. See the Read trait for some of the field descriptions.

contigName

the contig name (e.g. "chr12") that this read was mapped to.

alignmentQuality

the mapping quality, phred scaled.

start

the (0-based) reference locus that the first base in this read aligns to.

cigar

parsed samtools CIGAR object.

Linear Supertypes
Serializable, Serializable, Product, Equals, Region, Interval, HasContig, Read, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MappedRead
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Region
  7. Interval
  8. HasContig
  9. Read
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MappedRead(name: String, sequence: Bases, baseQualities: IndexedSeq[Byte], isDuplicate: Boolean, contigName: ContigName, alignmentQuality: Int, start: Locus, cigar: Cigar, failedVendorQualityChecks: Boolean, isPositiveStrand: Boolean, isPaired: Boolean)

    Permalink

    contigName

    the contig name (e.g. "chr12") that this read was mapped to.

    alignmentQuality

    the mapping quality, phred scaled.

    start

    the (0-based) reference locus that the first base in this read aligns to.

    cigar

    parsed samtools CIGAR object.

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. lazy val alignmentLikelihood: Double

    Permalink
  5. val alignmentQuality: Int

    Permalink

    the mapping quality, phred scaled.

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def asMappedRead: Some[MappedRead]

    Permalink
    Definition Classes
    MappedReadRead
  8. val baseQualities: IndexedSeq[Byte]

    Permalink

    The base qualities, phred scaled.

    The base qualities, phred scaled. These are numbers, and are NOT character encoded.

    Definition Classes
    MappedReadRead
  9. val cigar: Cigar

    Permalink

    parsed samtools CIGAR object.

  10. lazy val cigarElements: Vector[CigarElement]

    Permalink

    Individual components of the CIGAR string (e.g.

    Individual components of the CIGAR string (e.g. "10M"), parsed, and as a Scala buffer.

  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def contains(locus: Locus): Boolean

    Permalink
    Definition Classes
    Interval
  13. val contigName: ContigName

    Permalink

    the contig name (e.g.

    the contig name (e.g. "chr12") that this read was mapped to.

    Definition Classes
    MappedRead → HasContig
  14. val end: Locus

    Permalink

    The end of the alignment, exclusive.

    The end of the alignment, exclusive. This is the first reference locus AFTER the locus corresponding to the last base in this read.

    Definition Classes
    MappedRead → Interval
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. val failedVendorQualityChecks: Boolean

    Permalink

    Whether the read failed predefined vendor checks for quality

    Whether the read failed predefined vendor checks for quality

    Definition Classes
    MappedReadRead
  17. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  19. val isDuplicate: Boolean

    Permalink

    Is this read a duplicate of another?

    Is this read a duplicate of another?

    Definition Classes
    MappedReadRead
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. def isMapped: Boolean

    Permalink

    Is this read mapped?

    Is this read mapped?

    Definition Classes
    MappedReadRead
  22. val isPaired: Boolean

    Permalink

    Whether read is from a paired-end library

    Whether read is from a paired-end library

    Definition Classes
    MappedReadRead
  23. val isPositiveStrand: Boolean

    Permalink
  24. def iterator(): Iterator[Locus]

    Permalink
    Definition Classes
    Interval
  25. def length: NumLoci

    Permalink
    Definition Classes
    Interval
  26. val name: String

    Permalink
    Definition Classes
    MappedReadRead
  27. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  30. def overlaps(other: Region): Boolean

    Permalink
    Definition Classes
    Region
  31. def overlapsLocus(locus: Locus, halfWindowSize: WindowSize): Boolean

    Permalink
    Definition Classes
    Region
  32. val sequence: Bases

    Permalink

    The nucleotide sequence.

    The nucleotide sequence.

    Definition Classes
    MappedReadRead
  33. val start: Locus

    Permalink

    the (0-based) reference locus that the first base in this read aligns to.

    the (0-based) reference locus that the first base in this read aligns to.

    Definition Classes
    MappedRead → Interval
  34. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    MappedRead → Region → Interval → AnyRef → Any
  36. def unclippedEnd: Locus

    Permalink

    The end of the read's alignment, including any final clipped bases, exclusive.

  37. def unclippedStart: Locus

    Permalink

    A read can be "clipped", meaning that some prefix or suffix of it did not align.

    A read can be "clipped", meaning that some prefix or suffix of it did not align. This is the start of the whole read's alignment, including any initial clipped bases.

  38. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Region

Inherited from Interval

Inherited from HasContig

Inherited from Read

Inherited from AnyRef

Inherited from Any

Ungrouped