Header menu logo BioFSharp

Clustal Module

Contains functions for reading clustal alignment files

Types

Type Description

AlignmentInfo

Functions and values

Function or value Description

hasClustalFileHeader alignment

Full Usage: hasClustalFileHeader alignment

Parameters:
Returns: bool

Checks if the header of a parsed clustal alignment matches the clustal file conventions

alignment : Alignment<TaggedSequence<string, char>, AlignmentInfo>
Returns: bool

ofFile path

Full Usage: ofFile path

Parameters:
    path : string

Returns: Alignment<TaggedSequence<string, char>, AlignmentInfo>

Reads clustal File (W or Omega) of given path and creates an alignment out of it. Also reads in numbers at end of line. Those have to be filtered out afterwards if not needed.

path : string
Returns: Alignment<TaggedSequence<string, char>, AlignmentInfo>

toFileWithOverWrite path alignment

Full Usage: toFileWithOverWrite path alignment

Parameters:

Writes an alignment to given path in clustal format. Overwrites file if it already exists

path : string
alignment : Alignment<TaggedSequence<string, char>, AlignmentInfo>

Type something to start searching.