Header menu logo BioFSharp

ModificationInfo Module

Functionality for creating formula modifications

Types and nested modules

Type/Module Description

Table

Contains frequent modifications

ModLocation

Specifier for location of modification

Modification

Modification consisting of name, location specifier and a formula modifier

Functions and values

Function or value Description

createModification name isBiological location modifier

Full Usage: createModification name isBiological location modifier

Parameters:
Returns: Modification

Create modification, where molecule will be modified by application of given modifier

name : string
isBiological : bool
location : ModLocation
modifier : Formula -> Formula
Returns: Modification

createModificationWithAdd name isBiological location formula

Full Usage: createModificationWithAdd name isBiological location formula

Parameters:
    name : string
    isBiological : bool
    location : ModLocation
    formula : string

Returns: Modification

Create modification, where elements of given formula will be added to molecule

name : string
isBiological : bool
location : ModLocation
formula : string
Returns: Modification

createModificationWithSubstract name isBiological location formula

Full Usage: createModificationWithSubstract name isBiological location formula

Parameters:
    name : string
    isBiological : bool
    location : ModLocation
    formula : string

Returns: Modification

Create modification, where elements of given formula will be substracted molecule

name : string
isBiological : bool
location : ModLocation
formula : string
Returns: Modification

formula md

Full Usage: formula md

Parameters:
Returns: Formula

Returns then byteCode of a modification

md : Modification
Returns: Formula

isGap md

Full Usage: isGap md

Parameters:
Returns: bool

Returns true if the modification represents a sequence gap

md : Modification
Returns: bool

isTerminator md

Full Usage: isTerminator md

Parameters:
Returns: bool

Returns true if the modification represents a sequence terminator

md : Modification
Returns: bool

name md

Full Usage: name md

Parameters:
Returns: string

Returns then display name of a modification

md : Modification
Returns: string

symbol md

Full Usage: symbol md

Parameters:
Returns: char

Returns then symbol of a modification

md : Modification
Returns: char

toString md

Full Usage: toString md

Parameters:
Returns: string

Returns modification name as string

md : Modification
Returns: string

Type something to start searching.