Packages

c

feature

Region

sealed abstract class Region extends Ordered[Region]

A genomic region.

Can include zero, one, or multiple blocks on a chromosome. Includes an orientation. Does not include any further information.

Linear Supertypes
Ordered[Region], Comparable[Region], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Region
  2. Ordered
  3. Comparable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def addBlock(block: Block): Region

    Returns a merged Region representing this plus an additional Block.

    Returns a merged Region representing this plus an additional Block.

    The new Block is merged into this Region as in the Region.union method.

    If this and the new Block have incompatible Orientations or are on different chromosomes, an exception is thrown.

    block

    New Block to add

    returns

    Region representing this with the additional Block merged in

  2. abstract def blocks: List[Block]

    Returns a list of the Blocks of this Region.

    Returns a list of the Blocks of this Region.

    Regardless of Orientation, the returned list is in sorted order by chromosome coordinates.

  3. abstract def chr: String

    Returns the name of the chromosome on which this Region is located.

  4. abstract def chrPos(relativePos: Int): Int

    Returns the position in chromosome coordinates corresponding to a relative position along this Region.

    Returns the position in chromosome coordinates corresponding to a relative position along this Region.

    The requested relative position counts with respect to the "beginning" or "5-prime end" of this Region. It counts along the Blocks only, ignoring intervening areas ("introns").

    For example, if this Region has Orientation Plus, the relative position zero would map to the start position in chromosome coordinates by this method, and the relative position Region.size minus one would map to the last position (the end position minus one) in chromosome coordinates. If this Region has Orientation Minus, position zero would map to the last position of the Region (the end position minus one) by this method, and Region.size minus one would map to the start position.

    This Region must have Orientation Plus or Minus. The requested relative position must be between zero (inclusive) and Region.size (exclusive). Otherwise, an exception is thrown.

    relativePos

    Zero-based relative position with respect to this Region

    returns

    The zero-based position in chromosome coordinates

  5. abstract def compare(that: Region): Int
    Definition Classes
    Ordered
  6. abstract def contains(o: Region): Boolean

    Returns a boolean value representing whether this Region contains another Region.

    Returns a boolean value representing whether this Region contains another Region.

    In order to contain the other, the two Regions must be on the same chromosome, have compatible Orientations, and every block of the other Region must be fully contained in the span of a block of this Region.

    o

    Other Region

    returns

    True if this Region contains the other, false otherwise

  7. abstract def end: Int

    Returns the zero-based end position of this region.

    Returns the zero-based end position of this region.

    Regardless of Orientation, this one plus the largest (rightmost) position included in the region span in chromosome coordinates. That is to say, the end position is exclusive. (All coordinate intervals are half-open. All genomic positions are zero-based.)

  8. abstract def intersection(o: Region): Region

    Returns a Region representing the intersection of this with another Region.

    Returns a Region representing the intersection of this with another Region.

    If the two Regions overlap (Region.overlaps), a Region is returned whose blocks are the disjoint sections of overlap between the blocks of the two original Regions, and whose Orientation is the consensus (Orientation.consensus) of those of the two original Regions. If the two Regions do not overlap, Empty is returned.

    o

    Other Region

    returns

    Region representing the intersection of this with the other Region

  9. abstract def isEmpty: Boolean

    Returns a boolean value representing whether this Region is empty.

    Returns a boolean value representing whether this Region is empty.

    The only possible way for a region to be empty (have no blocks) is for it to be equal to Empty.

  10. abstract def minus(o: Region): Region

    Returns a Region representing this minus the overlap with another Region.

    Returns a Region representing this minus the overlap with another Region.

    If the two Regions overlap (Region.overlaps), a Region is returned whose blocks are the sections of this Region's blocks that are not part of the overlap. Otherwise, this is returned. In either case, the returned Region has the same Orientation as this Region.

    o

    Other Region

    returns

    Region representing this minus the other Region

  11. abstract def numBlocks: Int

    Returns the number of Blocks in this Region.

    Returns the number of Blocks in this Region.

    Empty has zero Blocks.

  12. abstract def orientation: Orientation

    Returns the Orientation of this region.

  13. abstract def overlaps(o: Region): Boolean

    Returns a boolean value representing whether this Region overlaps another Region.

    Returns a boolean value representing whether this Region overlaps another Region.

    In order to overlap, the two Regions must be on the same chromosome, have compatible Orientations, and have some pair of respective Blocks with overlapping spans.

    o

    Other Region

    returns

    True if the Regions overlap, false otherwise

  14. abstract def overlapsCompatibleIntrons(o: Region): Boolean

    Returns a boolean value representing whether this Region overlaps another Region and their introns are compatible.

    Returns a boolean value representing whether this Region overlaps another Region and their introns are compatible.

    That is, no INTERNAL block boundary for one of the Regions can fall strictly within a Block of the other Region.

    o

    Other Region

    returns

    True if the Regions overlap and their introns are compatible, false otherwise

  15. abstract def relativePos(chrPos: Int): Option[Int]

    Returns the position relative to this Region accounting for splicing and Orientation.

    Returns the position relative to this Region accounting for splicing and Orientation.

    The returned position counts with respect to the "beginning" or "5-prime end" of this Region. It counts along the Blocks only, ignoring intervening areas ("introns").

    For example, if this Region has Orientation Plus, the start position would map to position zero by this method, and the last position (the end position minus one) would map to position Region.size minus one. If this Region has Orientation Minus, the last position of the Region (the end position minus one) would map to position zero by this method, and the start position would map to position Region.size minus one.

    This Region must have Orientation Plus or Minus. Otherwise an exception is thrown.

    If the requested chromosome position does not lie within one of the Blocks of this Region, None is returned.

    chrPos

    Zero-based position in chromosome coordinates

    returns

    The zero-based converted position with respect to this Region, or None if the requested position does not overlap a Block of this Region

  16. abstract def start: Int

    Returns the zero-based start position of this region.

    Returns the zero-based start position of this region.

    Regardless of Orientation, this is the smallest (leftmost) position of the region in chromosome coordinates. The start position is inclusive. (All coordinate intervals are half open. All genomic positions are zero-based.)

  17. abstract def union(o: Region): Region

    Returns a Region representing the union of this with another Region.

    Returns a Region representing the union of this with another Region.

    If the two Regions are on the same chromosome and have compatible Orientations, the blocks will be merged and assigned the consensus Orientation (Orientation.consensus) for the final returned Region.

    If this or the other Region is Empty, the non-empty Region will be returned, or if both are Empty, Empty will be returned.

    Otherwise, an exception is thrown.

    o

    Other Region

    returns

    Region representing the union of this with the other Region

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def <(that: Region): Boolean
    Definition Classes
    Ordered
  4. def <=(that: Region): Boolean
    Definition Classes
    Ordered
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def >(that: Region): Boolean
    Definition Classes
    Ordered
  7. def >=(that: Region): Boolean
    Definition Classes
    Ordered
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def compareTo(that: Region): Int
    Definition Classes
    Ordered → Comparable
  11. def containsCompatibleIntrons(o: Region): Boolean

    Returns a boolean value representing whether this Region contains another Region and their introns are compatible.

    Returns a boolean value representing whether this Region contains another Region and their introns are compatible.

    That is, no INTERNAL block boundary for one of the Regions can fall strictly within a Block of the other Region.

    o

    Other Region

    returns

    True if this Region contains the other and their introns are compatible, false otherwise

  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  16. def getIntrons: List[Block]

    Returns a list of Blocks representing the introns of this Region.

    Returns a list of Blocks representing the introns of this Region.

    The returned list is in order from left to right. Each Block in the returned list is the span of a gap between two Blocks of this Region. The returned Blocks have the same Orientation as this Region. The start position of each returned Block is equal to the end position (exclusive) of the previous adjacent Block in this Region. The end position of each returned Block (exclusive) is equal to the start position of the following adjacent Block in this Region.

    If this Region is empty or has only one Block, Nil is returned.

    returns

    A list of Blocks representing the gaps between the Blocks of this Region, or Nil if this Region has less than two Blocks.

  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  22. def overlapsSpan(o: Region): Boolean

    Returns a boolean value representing whether the span of this Region overlaps the span of another Region.

    Returns a boolean value representing whether the span of this Region overlaps the span of another Region. That is, intron/exon structure is ignored and only the full span (from start to end) of the Regions are considered. Orientations must be compatible.

    o

    Other Region

    returns

    True if the spans of the Regions overlap, false otherwise

  23. def size: Int

    Returns the sum of the lengths of the Blocks of this Region.

    Returns the sum of the lengths of the Blocks of this Region.

    Block length is the end position minus the start position, where, as always, start position is inclusive and end position is exclusive. Therefore, size is the number of individual genomic positions included in the Region.

    The size of Empty is zero.

    returns

    The sum of the lengths of the Blocks of this Region

  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. def trim(newStart: Int, newEnd: Int): Region

    Returns a Region resulting from trimming back the start and end positions of this Region.

    Returns a Region resulting from trimming back the start and end positions of this Region.

    This Region is truncated to the new start and end positions in chromosome coordinates. This may mean some Blocks are removed altogether, some are shortened, and some are left intact. If the new start or end position is outside the span of this Region, that parameter will not affect the returned Region.

    As always, start positions are inclusive and end positions are exclusive.

    newStart

    New zero-based start position in chromosome coordinates

    newEnd

    New zero-based end position in chromosome coordinates

    returns

    Region representing this with truncated start and end positions

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

Inherited from Ordered[Region]

Inherited from Comparable[Region]

Inherited from AnyRef

Inherited from Any

Ungrouped