PeakML.Methods.getMassCorrection {mzmatch.R}R Documentation

PeakML.Methods.getMassCorrection

Description

Returns the mass correction based on the ionisation mode. If ionisation argument is set to "detect", then the ionisation mode is detected from the first scan in the first sample. No ionisation switching is supported in mzmatch.R yet.

Usage

	PeakML.Methods.getMassCorrection(PeakMLtree, ionisation="detect",filename=NULL)

Arguments

PeakMLtree

XML tree of PeakML file content.

ionisation

Defaults to "detect", to detect the ionisation from the scan data. Other accepted values are "positive" (proton coef = 1), "negative" (proton coef. = -1) and "neutral" (proton coef=0).

filename

The filename for the PeakML file. The path leading up to this file needs to exist, otherwise the function will fail. If filenames is provided PeakMLtree argument will be igonred, and XML tree created from given peakml file.

Details

The PeakML file format defines an open and extensible file format for storing extracted hyphenated mass spectrometry data. As such, the format will enable users to store intermediate data in a structured manner, but more importantly, to exchange data between different data analysis software. This will give complete flexible control to the users of data analysis software to cherry pick those components best suited to their needs. The PeakML.Methods contains a set of R functions that will enable end users to rapidly write scripts to manipulate PeakML files.

Value

getMassCorrection returns mass correction based on the ionisation mode, a numeric value.

Author(s)

Achuthanuni Chokkathukalam (unni.chokkathukalam@glasgow.ac.uk) Andris Jankevics (a.jankevics@rug.nl)

References

PeakML/mzMatch: A File Format, Java Library, R Library, and Tool-Chain for Mass Spectrometry Data Analysis, Richard A. Scheltema, Andris Jankevics, Ritsert C. Jansen, Morris A. Swertz, Rainer Breitling, Analytical Chemistry, 2011 83 (7), 2786-2793.

See Also

PeakML.Methods.getProtonMass, PeakML.Methods.getProtonCoef


[Package mzmatch.R version 2.0-6 Index]