dentist.common.alignments

Everything to handle local alignments and friends.

Members

Aliases

PileUp
alias PileUp = ReadAlignment[]

A pile of read alignments belonging to the same gap/contig end.

Enums

AlignmentLocationSeed
enum AlignmentLocationSeed

Type of the read alignment.

ReadAlignmentType
enum ReadAlignmentType

Type of the read alignment.

Functions

alignmentCoverage
double alignmentCoverage(in AlignmentChain[] alignments)

Calculates the coverage of the contigs by the given alignments. Only contigs involved in the alignments are regarded.

getAlignmentRefs
AlignmentChain*[] getAlignmentRefs(PileUp pileUp)

Returns a list of pointers to all involved alignment chains.

getType
ReadAlignmentType getType(in PileUp pileUp)

Get the type of the read alignment.

isBefore
bool isBefore(in AlignmentChain ac1, in AlignmentChain ac2)

Returns true iff ac1 begins before ac2 on the given contig (in).

makeJoin
J makeJoin(ReadAlignment readAlignment)

Generate basic join from read alignment.

to
J to(ReadAlignment readAlignment)

Generate join from read alignment.

Structs

AlignmentChain
struct AlignmentChain

Holds a chain of local alignments that form a compound alignment. An AlignmentChain should contain at least one element.

ReadAlignment
struct ReadAlignment

Alignment of a read against the reference. This is either one or two alignment chains which belong to the same read and one or two reference contig(s).

SeededAlignment
struct SeededAlignment

An alignment chain with a "seed", ie. hint for it's intended location.

Meta

License

Subject to the terms of the MIT license, as written in the included LICENSE file.

Authors

Arne Ludwig <arne.ludwig@posteo.de>