methodStore-class: Object to handle all peak detection methods

Description Fields Methods

Description

This peakMethods object is the sole instance of a peakMethodStore reference class. Its responsibility is to index all registered peak detection algorithms and perform input and output check upon calling the functions. This object should not be interacted with directly but through detectPeaks methods for the different object from MSsary.

Fields

functions

A named list with all registered peak detection functions

requirements

A named list with requirements for all reqistered functions

package

A named list with the package from where the function was registered

version

A named list with the version of the package stated in the package field

Methods

getMethod(name)

Get the function of the given name

getPackage(name)

Get the package from where a function originates

getVersion(name)

Get the version of the package from where a function originates

hasMethod(name)

Check for registered functions of the given name

initialize()

Initialize the object to be empty

registerMethod(name, fun, req = list())

Register a new function with the given 'name' and optionally sets the requirements

testInput(name, scans, info)

Test the provided inputs to see if they are sound and corresponds to the requirements set when the function was reqistered

useMethod(name, scans, info, ...)

Runs the function given by 'name' with the supplied arguments. Input and output are automatically tested to ensure conformance.


thomasp85/MSsary documentation built on May 31, 2019, 11:11 a.m.