Header menu logo BioFSharp

Mgf Module

Mgf `_ is a simple human-readable format for MS/MS data. It allows storing MS/MS peak lists and exprimental parameters.

Types

Type Description

MgfEntry

Represents

Functions and values

Function or value Description

createMgfEntry parameters mass intensity

Full Usage: createMgfEntry parameters mass intensity

Parameters:
    parameters : Map<string, string>
    mass : float[]
    intensity : float[]

Returns: MgfEntry
parameters : Map<string, string>
mass : float[]
intensity : float[]
Returns: MgfEntry

mgfToString mgf

Full Usage: mgfToString mgf

Parameters:
Returns: string seq

Converts a MgfEntry to string. Use Seq.write to write to file.

mgf : MgfEntry
Returns: string seq

readMgf path

Full Usage: readMgf path

Parameters:
    path : string

Returns: MgfEntry list

Reads an mgf file into a collection of MgfEntries

path : string
Returns: MgfEntry list

tryGetPrecursorCharges mgf

Full Usage: tryGetPrecursorCharges mgf

Parameters:
Returns: int list option

Returns the precursor mass. Returns None if the information can't be optained

mgf : MgfEntry
Returns: int list option

tryGetPrecursorMZ mgf

Full Usage: tryGetPrecursorMZ mgf

Parameters:
Returns: float option

Returns the precursor mz. Returns None if the information can't be optained

mgf : MgfEntry
Returns: float option

tryGetPrecursorMass mgf

Full Usage: tryGetPrecursorMass mgf

Parameters:
Returns: float option

Returns the precursor mass. Returns None if the information can't be optained

mgf : MgfEntry
Returns: float option

tryGetTitle mgf

Full Usage: tryGetTitle mgf

Parameters:
Returns: string option

Returns the title string of a 'mgf-entry'. Returns None if the information can't be optained

mgf : MgfEntry
Returns: string option

tryParseCharge str

Full Usage: tryParseCharge str

Parameters:
    str : string

Returns: int list option

Returns the posible charge/charges in a list. Returns None if the information can't be optained

str : string
Returns: int list option

tryParseTitle title

Full Usage: tryParseTitle title

Parameters:
    title : string

Returns: (float * float) option

Returns the retention time and precursor intensity from 'mgf-title' string. Returns None if title does not contain the information

title : string
Returns: (float * float) option

Type something to start searching.