Header menu logo BioFSharp

FastaItem<'SequenceItem> Type

A FastaItem represents a sequence record in a fasta formatted file, consisting of header line and sequence

Record fields

Record Field Description

Header

Full Usage: Header

Field type: string
Field type: string

Sequence

Full Usage: Sequence

Field type: 'SequenceItem seq
Field type: 'SequenceItem seq

Static members

Static member Description

FastaItem.create header sequence

Full Usage: FastaItem.create header sequence

Parameters:
    header : string - The header line of the sequence record
    sequence : 'a - The sequence

Returns: FastaItem<'SequenceItem0>
Modifiers: inline

Creates a fasta item representing a single sequence record in a fasta formatted file.

header : string

The header line of the sequence record

sequence : 'a

The sequence

Returns: FastaItem<'SequenceItem0>

FastaItem.ofTaggedSequence tagConverter sequenceItemConverter taggedSeq

Full Usage: FastaItem.ofTaggedSequence tagConverter sequenceItemConverter taggedSeq

Parameters:
    tagConverter : 'Tag -> string -
    sequenceItemConverter : 'TaggedSequenceItem -> 'SequenceItem
    taggedSeq : TaggedSequence<'Tag, 'TaggedSequenceItem> - the tagged sequence to convert

Returns: FastaItem<'SequenceItem>
Modifiers: inline
Type parameters: 'TaggedSequenceItem

Creates a fasta item from a tagged sequence.

tagConverter : 'Tag -> string

sequenceItemConverter : 'TaggedSequenceItem -> 'SequenceItem
taggedSeq : TaggedSequence<'Tag, 'TaggedSequenceItem>

the tagged sequence to convert

Returns: FastaItem<'SequenceItem>

FastaItem.toLines sequenceItemConverter fsa

Full Usage: FastaItem.toLines sequenceItemConverter fsa

Parameters:
    sequenceItemConverter : 'SequenceItem -> char - A function to convert sequence items to characters
    fsa : FastaItem<'SequenceItem> - the fasta item to convert

Returns: string seq

Converts the FastaItem to a sequence of lines. The header line is prefixed with '>' and the sequence is split into chunks of 80 characters.

sequenceItemConverter : 'SequenceItem -> char

A function to convert sequence items to characters

fsa : FastaItem<'SequenceItem>

the fasta item to convert

Returns: string seq

FastaItem.toString sequenceItemConverter fsa

Full Usage: FastaItem.toString sequenceItemConverter fsa

Parameters:
    sequenceItemConverter : 'SequenceItem -> char - A function to convert sequence items to characters
    fsa : FastaItem<'SequenceItem> - the fasta item to convert

Returns: string

Converts the FastaItem to a string. The header line is prefixed with '>' and the sequence is split into chunks of 80 characters per line.

sequenceItemConverter : 'SequenceItem -> char

A function to convert sequence items to characters

fsa : FastaItem<'SequenceItem>

the fasta item to convert

Returns: string

FastaItem.toTaggedSequence headerConverter fsa

Full Usage: FastaItem.toTaggedSequence headerConverter fsa

Parameters:
    headerConverter : string -> 'Tag - A function to convert header to tag
    fsa : FastaItem<'SequenceItem> - the fasta item to convert

Returns: TaggedSequence<'Tag, 'SequenceItem>
Modifiers: inline

Converts the FastaItem to a tagged sequence. The header line is converted to a tag type of choice using the provided converter function.

headerConverter : string -> 'Tag

A function to convert header to tag

fsa : FastaItem<'SequenceItem>

the fasta item to convert

Returns: TaggedSequence<'Tag, 'SequenceItem>

Type something to start searching.