Header menu logo BioFSharp

GenBank Module

functions for reading and writing GenBank files

Types

Type Description

Feature

Represents a single feature from the FEATURES section of a GenBank file. Features can contain Information about genes and gene products, as well as regions of biological significance reported in the sequence

FeatureQualifier

Represents a single feature Qualifier and its value from the FEATURES section of a Genbank file. Features can contain Information about genes and gene products, as well as regions of biological significance reported in the sequence

GenBankItem<'SequenceItem>

Represents any Item a GenBank file can contain as a union case. The result of parsing a genBank file will be a dictionary containing this type.

Functions and values

Function or value Description

getFeatures gb

Full Usage: getFeatures gb

Parameters:
Returns: Feature list

Returns all features of a GenBank file representation

gb : Dictionary<string, GenBankItem<'SequenceItem>>
Returns: Feature list

getFeaturesWithType featureType gb

Full Usage: getFeaturesWithType featureType gb

Parameters:
Returns: Feature list

Returns all features of a specific type of a GenBank file representation

featureType : string
gb : Dictionary<string, GenBankItem<'SequenceItem>>
Returns: Feature list

getOrigin gb

Full Usage: getOrigin gb

Parameters:
Returns: 'SequenceItem seq

Returns the Origin of a GenBank file representation

gb : Dictionary<string, GenBankItem<'SequenceItem>>
Returns: 'SequenceItem seq

getReferences gb

Full Usage: getReferences gb

Parameters:
Returns: (string * string) list list

Returns all references of a GenBank file representation

gb : Dictionary<string, GenBankItem<'SequenceItem>>
Returns: (string * string) list list

getValues gb

Full Usage: getValues gb

Parameters:
Returns: (string * string) list

Returns all Values of the meta section of a Genbank file representation

gb : Dictionary<string, GenBankItem<'SequenceItem>>
Returns: (string * string) list

toLines originSequenceConverter gb

Full Usage: toLines originSequenceConverter gb

Parameters:
    originSequenceConverter : 'SequenceItem seq -> char seq
    gb : Dictionary<string, GenBankItem<'SequenceItem>>

Returns: string seq

creates a GenBank file at the specified path, taking a converter function for the origin sequence of the file

originSequenceConverter : 'SequenceItem seq -> char seq
gb : Dictionary<string, GenBankItem<'SequenceItem>>
Returns: string seq

toString originSequenceConverter gb

Full Usage: toString originSequenceConverter gb

Parameters:
    originSequenceConverter : 'SequenceItem seq -> char seq
    gb : Dictionary<string, GenBankItem<'SequenceItem>>

Returns: string
originSequenceConverter : 'SequenceItem seq -> char seq
gb : Dictionary<string, GenBankItem<'SequenceItem>>
Returns: string

tryGetItem key gb

Full Usage: tryGetItem key gb

Parameters:
Returns: GenBankItem<'SequenceItem> option

Returns a GenBank item at the specified key, if it exists in the dictionary

key : string
gb : Dictionary<string, GenBankItem<'SequenceItem>>
Returns: GenBankItem<'SequenceItem> option

Type something to start searching.