loadMSLibrary: Loading of MS library data

In rickhelmus/patRoon: Workflows for Mass-Spectrometry Based Non-Target Analysis

Loading of MS library data

Description

Loads, parses, verifies and curates MS library data, e.g. obtained from MassBank.

Usage

loadMSLibrary(file, algorithm, ...)

Arguments

file	A character string that specifies the the file path to the library.
algorithm	A character string describing the algorithm that should be used: "msp", "json"
...	Any parameters to be passed to the selected MS library loading algorithm.

Details

loadMSLibrary is a generic function that will loads MS library data by one of the supported algorithms. The actual functionality is provided by algorithm specific functions such as loadMSLibraryMSP and loadMSLibraryMoNAJSON. While these functions may be called directly, loadMSLibrary provides a generic interface and is therefore usually preferred.

Value

A MSLibrary object containing the loaded library data.

See Also

The MSLibrary output class and its methods and the algorithm specific functions: loadMSLibraryMSP, loadMSLibraryMoNAJSON

rickhelmus/patRoon documentation built on April 25, 2024, 8:15 a.m.