case class Template(r1: Option[SamRecord], r2: Option[SamRecord], r1Supplementals: Seq[SamRecord] = Nil, r2Supplementals: Seq[SamRecord] = Nil, r1Secondaries: Seq[SamRecord] = Nil, r2Secondaries: Seq[SamRecord] = Nil) extends Product with Serializable
Class that represents all reads from a template within a BAM file.
- Alphabetic
- By Inheritance
- Template
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Template, B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
allReads: Iterator[SamRecord]
Returns an iterator of all reads for the template.
-
def
allSupplementaryAndSecondary: Iterator[SamRecord]
Returns an iterator over all records that are not the primary r1 and r2.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def ensuring(cond: (Template) ⇒ Boolean, msg: ⇒ Any): Template
- def ensuring(cond: (Template) ⇒ Boolean): Template
- def ensuring(cond: Boolean, msg: ⇒ Any): Template
- def ensuring(cond: Boolean): Template
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
val
name: String
Gets the query name of the template (assumes all records have the same read name).
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
pairOrientation: Option[PairOrientation]
If both the R1 and R2 are present and mapped to the same chromosome returns the pair orientation, else None.
-
def
primaryReads: Iterator[SamRecord]
Returns an iterator over all non-secondary non-supplementary reads.
- val r1: Option[SamRecord]
- val r1Secondaries: Seq[SamRecord]
- val r1Supplementals: Seq[SamRecord]
- val r2: Option[SamRecord]
- val r2Secondaries: Seq[SamRecord]
- val r2Supplementals: Seq[SamRecord]
-
lazy val
readCount: Int
The total count of records for the template.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
unmapped: Template
Produces a copy of the template that has had mapping information removed.
Produces a copy of the template that has had mapping information removed. Discards secondary and supplementary records, and retains the primary records after un-mapping them. Auxillary tags listed in Bams.AlignmentTags are removed from all records. Lastly the
OA
tag is added to reads to record the Original Alignment. -
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def →[B](y: B): (Template, B)