Class/Object

org.bdgenomics.adam.models

ReadGroupDictionary

Related Docs: object ReadGroupDictionary | package models

Permalink

case class ReadGroupDictionary(readGroups: Seq[ReadGroup]) extends Product with Serializable

Builds a dictionary containing read groups.

Read groups must have a unique name across all samples in the dictionary. This dictionary provides numerical IDs for each group; these IDs are only consistent when referencing a single dictionary.

readGroups

A seq of read groups to populate the dictionary.

Exceptions thrown

IllegalArgumentException Throws an assertion error if there are multiple read groups with the same name.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReadGroupDictionary
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ReadGroupDictionary(readGroups: Seq[ReadGroup])

    Permalink

    readGroups

    A seq of read groups to populate the dictionary.

    Exceptions thrown

    IllegalArgumentException Throws an assertion error if there are multiple read groups with the same name.

Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def ++(that: ReadGroupDictionary): ReadGroupDictionary

    Permalink

    Merges together two read group dictionaries.

    Merges together two read group dictionaries.

    that

    The read group dictionary to merge with.

    returns

    The merged read group dictionary.

  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def apply(readGroupId: String): ReadGroup

    Permalink

    Returns the read group entry for an associated id.

    Returns the read group entry for an associated id.

    readGroupId

    The read group to look up.

    returns

    Detailed info for a read group.

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def getIndex(readGroupId: String): Int

    Permalink

    Returns the numerical index for a given read group id.

    Returns the numerical index for a given read group id.

    readGroupId

    The read group to find an index for.

    returns

    Returns a numerical index for a read group.

    Note

    This index is only guaranteed to have the same value for a given read group id when the index is pulled from the same read group dictionary.

  12. def isEmpty: Boolean

    Permalink

    returns

    Returns true if this dictionary contains no read groups.

  13. final def isInstanceOf[T0]: Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef
  17. val readGroupMap: Map[String, (ReadGroup, Int)]

    Permalink

    A representation of this read group dictionary that can be indexed into by read group id.

  18. val readGroups: Seq[ReadGroup]

    Permalink

    A seq of read groups to populate the dictionary.

  19. def size: Int

    Permalink

    The number of read groups in the dictionary.

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

    Permalink
    Definition Classes
    AnyRef
  21. def toSamples: Seq[Sample]

    Permalink

    returns

    Converts this read group dictionary to a set of samples.

  22. def toString(): String

    Permalink
    Definition Classes
    ReadGroupDictionary → AnyRef → Any
  23. final def wait(): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. 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 AnyRef

Inherited from Any

Ungrouped