getData: getData

In cbroeckl/RAMClustR: Mass Spectrometry Metabolomics Feature Clustering and Interpretation

getData

Description

retrieve and parse sample names, retrieve metabolite data. returns as list of two data frames

Usage

getData(
  ramclustObj = NULL,
  which.data = "SpecAbund",
  delim = "-",
  cmpdlabel = "cmpd",
  filter = FALSE
)

Arguments

ramclustObj	ramclustR object to retrieve data from
which.data	character; which dataset (SpecAbund or SpecAbundAve) to reference
delim	character; "-" by default - the delimiter for parsing sample names to factors
cmpdlabel	= "cmpd"; label the data with the annotation. can also be set to 'ann' for column names assigned as annotatins.
filter	= TRUE; logical, if TRUE, checks for $cmpd.use slot generated by rc.cmpd.cv.filter() function, and only gets acceptable compounds.

Details

convenience function for parsing sample names and returning a dataset.

Value

returns a list of length 3: $design is the experimental sample factors after parsing by the delim, $data is the dataset, $full.data is merged $des and $data data.frames.

Author(s)

Corey Broeckling

cbroeckl/RAMClustR documentation built on Sept. 1, 2024, 1:50 a.m.