Packages

package alignment

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

Type Members

  1. class Aligner extends AnyRef

    Implementation of an aligner with generic scoring function and affine gap penalty support.

    Implementation of an aligner with generic scoring function and affine gap penalty support. Supports multiple alignment Modes for global, semi-global and local alignment.

    A scoring function (scoringFunction) is taken to score pair-wise aligned bases. A default implementation is supplied via the companion Aligner object which uses a fixed match score and mismatch penalty.

  2. case class Alignment (query: Array[Byte], target: Array[Byte], queryStart: Int, targetStart: Int, cigar: Cigar, score: Int) extends Product with Serializable

    A general class to describe the alignment between two sequences or partial ranges thereof

    A general class to describe the alignment between two sequences or partial ranges thereof

    query

    the query sequence

    target

    the target sequence

    queryStart

    the 1-based position in the query sequence where the alignment begins

    targetStart

    the 1-based position in the target sequence where the alignment begins

    cigar

    a Cigar object describing the alignment of the two sequences

    score

    the alignment score

  3. case class Cigar (elems: IndexedSeq[CigarElem]) extends Iterable[CigarElem] with Product with Serializable

    Object representation of a Cigar string representing an alignment between two sequences.

    Object representation of a Cigar string representing an alignment between two sequences.

    elems

    the ordered sequence of elements in the Cigar

  4. case class CigarElem (operator: CigarOperator, length: Int) extends Product with Serializable

    Represents an element in a Cigar.

    Represents an element in a Cigar.

    operator

    the type of element (e.g. match, insertion, etc.)

    length

    the length of the element in bases (must be greater than 0).

  5. class LinearMatrix [A] extends Matrix[A]

    Implements a matrix using a single linear array.

  6. trait Matrix [A] extends AnyRef

    Defines methods applicable to a 2D matrix.

    Defines methods applicable to a 2D matrix. Matrix cells are accessed with a pair of coordinates, the first of which is the row offset starting at 0, and the second of which is the column offset, starting at 0.

  7. sealed trait Mode extends EnumEntry

    Trait that entries in Mode will extend.

  8. type NeedlemanWunschAligner = Aligner
    Annotations
    @deprecated
    Deprecated

Value Members

  1. object Aligner
  2. object Alignment extends Serializable

    Companion object for Alignment.

  3. object Cigar extends Serializable

    Companion object for Cigar that offers alternative constructors.

  4. object Matrix

    Factory method(s) for Matrices.

  5. object Mode extends FgBioEnum[Mode]

    Enum to represent alignment modes supported by the Aligner.

Deprecated Value Members

  1. val NeedlemanWunschAligner: Aligner.type
    Annotations
    @deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped