Header menu logo BioFSharp

FastqItem<'SequenceItem, 'QualitySequenceItem> Type

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

Record fields

Record Field Description

Header

Full Usage: Header

Field type: string
Field type: string

QualityHeader

Full Usage: QualityHeader

Field type: string
Field type: string

QualitySequence

Full Usage: QualitySequence

Field type: 'QualitySequenceItem seq
Field type: 'QualitySequenceItem seq

Sequence

Full Usage: Sequence

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

Static members

Static member Description

FastqItem.create header sequence qualityHeader qualitySequence

Full Usage: FastqItem.create header sequence qualityHeader qualitySequence

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

Returns: FastqItem<'SequenceItem0, 'QualitySequenceItem1>
Modifiers: inline

Creates FastqItem with header line, sequence, qualityHeader and qualitySequence

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

FastqItem.toLines sequenceItemConverter qualitySequenceItemConverter fsq

Full Usage: FastqItem.toLines sequenceItemConverter qualitySequenceItemConverter fsq

Parameters:
    sequenceItemConverter : 'SequenceItem -> char - A function to convert sequence items to characters
    qualitySequenceItemConverter : 'QualitySequenceItem -> char
    fsq : FastqItem<'SequenceItem, 'QualitySequenceItem>

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

qualitySequenceItemConverter : 'QualitySequenceItem -> char
fsq : FastqItem<'SequenceItem, 'QualitySequenceItem>
Returns: string seq

FastqItem.toString sequenceItemConverter qualitySequenceItemConverter fsq

Full Usage: FastqItem.toString sequenceItemConverter qualitySequenceItemConverter fsq

Parameters:
    sequenceItemConverter : 'SequenceItem -> char - A function to convert sequence items to characters
    qualitySequenceItemConverter : 'QualitySequenceItem -> char
    fsq : FastqItem<'SequenceItem, 'QualitySequenceItem>

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

qualitySequenceItemConverter : 'QualitySequenceItem -> char
fsq : FastqItem<'SequenceItem, 'QualitySequenceItem>
Returns: string

Type something to start searching.