Header menu logo BioFSharp

FastA Module

Types

Type Description

FastaItem<'a>

Fasta item contains header and sequence

Functions and values

Function or value Description

createFastaItem header sequence

Full Usage: createFastaItem header sequence

Parameters:
    header : string
    sequence : 'a

Returns: FastaItem<'a>

Creates with header line and sequence.

header : string
sequence : 'a
Returns: FastaItem<'a>

fromFile converter filePath

Full Usage: fromFile converter filePath

Parameters:
    converter : char seq -> 'a
    filePath : string

Returns: FastaItem<'a> seq

Reads FastaItem from file. Converter determines type of sequence by converting seq -> type

converter : char seq -> 'a
filePath : string
Returns: FastaItem<'a> seq

fromFileEnumerator converter fileEnumerator

Full Usage: fromFileEnumerator converter fileEnumerator

Parameters:
    converter : char seq -> 'a
    fileEnumerator : string seq

Returns: FastaItem<'a> seq

Reads FastaItem from file. Converter determines type of sequence by converting seq -> type

converter : char seq -> 'a
fileEnumerator : string seq
Returns: FastaItem<'a> seq

fromGzipFile converter filePath

Full Usage: fromGzipFile converter filePath

Parameters:
    converter : char seq -> 'a
    filePath : string

Returns: FastaItem<'a> seq

Reads FastaItem from gzFile. Converter determines type of sequence by converting seq -> type

converter : char seq -> 'a
filePath : string
Returns: FastaItem<'a> seq

toString toString data

Full Usage: toString toString data

Parameters:
    toString : 'T -> char
    data : FastaItem<'a> seq

Returns: string seq

Converts FastaItem to string. Converter determines type of sequence by converting type -> char

toString : 'T -> char
data : FastaItem<'a> seq
Returns: string seq

toTaggedSequence fsa

Full Usage: toTaggedSequence fsa

Parameters:
Returns: TaggedSequence<string, 'a>
fsa : FastaItem<'S>
Returns: TaggedSequence<string, 'a>

write toString filePath data

Full Usage: write toString filePath data

Parameters:
    toString : 'T -> char
    filePath : string
    data : FastaItem<'a> seq

Writes FastaItem to file. Converter determines type of sequence by converting type -> char. If file already exists the data is overwritten.

toString : 'T -> char
filePath : string
data : FastaItem<'a> seq

writeAndAppend toString filePath data

Full Usage: writeAndAppend toString filePath data

Parameters:
    toString : 'T -> char
    filePath : string
    data : FastaItem<'a> seq

Writes FastaItem to file. Converter determines type of sequence by converting type -> char. If file already exists the data is appended.

toString : 'T -> char
filePath : string
data : FastaItem<'a> seq

writeToStream toString stream data

Full Usage: writeToStream toString stream data

Parameters:

Writes FastaItem to stream. Converter determines type of sequence by converting type -> char The passed stream stays open and is not disposed after writing to it. If you want to reuse the stream (e.g. you are not writing to a file stream but a memory stream that gets used afterwards) you have to reset the position with `stream.Seek(0L, SeekOrigin.Begin)`

toString : 'T -> char
stream : Stream
data : FastaItem<'a> seq

Type something to start searching.