Header menu logo BioFSharp

GenBank Module

functions for reading and writing GenBank files

Types and nested modules

Type/Module Description

OriginConverters

contains prebuilt converters for origin sequences in a gb file for both reading and writing

Read

functions for parsing a GenBank file.

Write

Functions for writing a GenBank file

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<'a>

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

createFeature t bs qual

Full Usage: createFeature t bs qual

Parameters:
Returns: Feature
t : string
bs : string
qual : FeatureQualifier list
Returns: Feature

createFeatureQualifier name value

Full Usage: createFeatureQualifier name value

Parameters:
    name : string
    value : string

Returns: FeatureQualifier
name : string
value : string
Returns: FeatureQualifier

getFeatures gb

Full Usage: getFeatures gb

Parameters:
Returns: Feature list

Returns all features of a GenBank file representation

gb : Dictionary<string, GenBankItem<'a>>
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<'a>>
Returns: Feature list

getOrigin gb

Full Usage: getOrigin gb

Parameters:
Returns: 'a

Returns the Origin of a GenBank file representation

gb : Dictionary<string, GenBankItem<'a>>
Returns: 'a

getReferences gb

Full Usage: getReferences gb

Parameters:
Returns: (string * string) list list

Returns all references of a GenBank file representation

gb : Dictionary<string, GenBankItem<'a>>
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<'a>>
Returns: (string * string) list

tryGetItem key gb

Full Usage: tryGetItem key gb

Parameters:
Returns: GenBankItem<'a> option

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

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

Type something to start searching.