RDataParam: Store 'XcmsExperiment' object as .RData file

In sneumann/xcms: LC-MS and GC-MS Data Analysis

Store 'XcmsExperiment' object as .RData file

Description

The 'RDataParam' class and method allow users to save an 'XcmsExperiment' object as an .RData file with a chosen filename. The object gets exported using ['save()'] function. This 'param' class and method are part of the possible dispatch of the generic function 'storeResults'.

Usage

RDataParam(fileName = tempfile())

## S4 method for signature 'XcmsExperiment,RDataParam'
storeResults(object, param)

Arguments

fileName	for 'RDataParam' 'character(1)', defining the file name. The default will be 'tempfile()'.
object	MsExperiment or XcmsExperiment The data object that needs to be saved.
param	The parameter object selecting and configuring the format for saving. It can be one of the following classes: RDataParam, PlainTextParam, or MzTabMParam.

Value

for 'RDataParam': a 'RDataParam' class. 'storeResults' does not return anything but saves the object to a RData file.

Author(s)

Philippine Louail

See Also

Other xcms result export formats.: PlainTextParam

Examples

## Load a test data set with detected peaks
faahko_sub <- loadXcmsData("faahko_sub2")

## Define param 
param <- RDataParam(fileName = "example_xcms_object")

## Save as RData
storeResults(object = faahko_sub, param = param)

sneumann/xcms documentation built on April 26, 2024, 3:05 a.m.