Header menu logo BioFSharp

Alignment Module

Basic structure and functionality for sequence alignments. Alignment functions can be found in the BioFSharp.Algorithm namespace.

Types

Type Description

Alignment<'Sequence, 'Metadata>

General Alignment type used throughout BioFSharp

Functions and values

Function or value Description

createAlignment metaData sequences

Full Usage: createAlignment metaData sequences

Parameters:
    metaData : 'a
    sequences : 'b seq

Returns: Alignment<'b, 'a>

Creates Alignment type

metaData : 'a
sequences : 'b seq
Returns: Alignment<'b, 'a>

mapSequences mapping alignment

Full Usage: mapSequences mapping alignment

Parameters:
    mapping : 'Sequence -> 'mSequence
    alignment : Alignment<'Sequence, 'a>

Returns: Alignment<'mSequence, 'a>

Mapping function for aligned sequences, keeping the associated metadata.

mapping : 'Sequence -> 'mSequence
alignment : Alignment<'Sequence, 'a>
Returns: Alignment<'mSequence, 'a>

mapmetaData mapping alignment

Full Usage: mapmetaData mapping alignment

Parameters:
    mapping : 'Metadata -> 'NewMetadata
    alignment : Alignment<'Sequence, 'Metadata>

Returns: Alignment<'Sequence, 'NewMetadata>

Mapping function for aligned sequences, keeping the associated metadata.

mapping : 'Metadata -> 'NewMetadata
alignment : Alignment<'Sequence, 'Metadata>
Returns: Alignment<'Sequence, 'NewMetadata>

Type something to start searching.