PeakML.xcms.write: PeakML.xcms.write

Description Usage Arguments Details Value Author(s) References See Also

View source: R/PeakML.xcms.write.R

Description

This function writes the given XCMS set to the given filename in the PeakML format. This file format supports the mass traces (features) and the sets-structure utilized by XCMS and as such provides a fully reproducible representation of the contents of an XCMS set structure.

Usage

1
  PeakML.xcms.write(xset, filename, ionisation="detect")

Arguments

xset

The XCMS set structure containing the data to be written to the PeakML file.

filename

The filename for the PeakML file. The path leading up to this file needs to exist, otherwise the function will fail.

ionisation

Character value to be set on to "positive" if positive ionisation mode data are processed. And "negative" if negative ionisaton mode was used. Default value is seto to "detect", ionisation mode will be detected from the RAW data 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.xcms.write function extends the XCMS package with write functionality for exporting data to other applications. For example, the results of an XCMS step can then be loaded in the user interface environment PeakML Viewer and manipulated there.

Value

This function returns no value.

Author(s)

Andris Jankevics (a.jankevics@rug.nl) Richard Scheltema (r.a.scheltema@rug.nl)

References

PeakML/mzMatch - a file format, Java library, R library and tool-chain for mass spectrometry data analysis. In preparation.

See Also

PeakML.xcms.read


andzajan/mzmatch.R documentation built on Dec. 1, 2020, 11:33 a.m.