Header menu logo BioFSharp

FastQ Module

Types

Type Description

FastqItem<'a, 'b>

FastqItem record contains header, sequence, qualityheader, qualitysequence of one entry

Functions and values

Function or value Description

createFastqItem header sequence qualityHeader qualitySequence

Full Usage: createFastqItem header sequence qualityHeader qualitySequence

Parameters:
    header : string
    sequence : 'a
    qualityHeader : string
    qualitySequence : 'b

Returns: FastqItem<'a, 'b>

Creates FastqItem with header line, sequence, qualityHeader and qualitySequence

header : string
sequence : 'a
qualityHeader : string
qualitySequence : 'b
Returns: FastqItem<'a, 'b>

fromFile converter qualityConverter filePath

Full Usage: fromFile converter qualityConverter filePath

Parameters:
    converter : string -> 'a
    qualityConverter : string -> 'b
    filePath : string

Returns: FastqItem<'a, 'b> seq

Reads FastqItem from FastQ format file. Converter and qualityConverter determines type of sequence by converting seq -> type

converter : string -> 'a
qualityConverter : string -> 'b
filePath : string
Returns: FastqItem<'a, 'b> seq

fromFileEnumerator converter qualityConverter fileEnumerator

Full Usage: fromFileEnumerator converter qualityConverter fileEnumerator

Parameters:
    converter : string -> 'a
    qualityConverter : string -> 'b
    fileEnumerator : string seq

Returns: FastqItem<'a, 'b> seq

Maps each lines from an entry to FastqItem

converter : string -> 'a
qualityConverter : string -> 'b
fileEnumerator : string seq
Returns: FastqItem<'a, 'b> seq

fromGzipFile converter qualityConverter filePath

Full Usage: fromGzipFile converter qualityConverter filePath

Parameters:
    converter : string -> 'a
    qualityConverter : string -> 'b
    filePath : string

Returns: FastqItem<'a, 'b> seq

Reads FastqItem from GZip format file. Converter and qualityConverter determines type of sequence by converting seq -> type

converter : string -> 'a
qualityConverter : string -> 'b
filePath : string
Returns: FastqItem<'a, 'b> seq

Type something to start searching.