PerformPeakProfiling: Perform peak annotation This function performs feature...

Description Usage Arguments Author(s)

View source: R/preproc_utils.R

Description

Perform peak annotation This function performs feature extraction of user's raw MS data using the rawData object created using the InspectRawMSData function.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
PerformPeakProfiling(
  rawData,
  peakParams,
  rtPlot = TRUE,
  pcaPlot = TRUE,
  labels = TRUE,
  format = "png",
  dpi = 72,
  width = 9,
  rtplot_name = "RT_adjustment",
  pcaplot_name = "PCA_plot"
)

Arguments

rawData

The object created using the InspectRawMSData function, containing the raw MS data.

peakParams

The object created using the SetPeakParam function, containing user's specified or default parameters for downstream raw MS data pre-processing.

rtPlot

Logical, if true creates a plot of retention time correction. Defaut is set to true.

pcaPlot

Logical, if true creates a PCA plot to evaluate the sample grouping. Default is set to true.

labels

Logical, if true, the PCA plot will be annotated with sample names.

format

Character, input the format of the image to create.

dpi

Numeric, input the dpi of the image to create.

width

Numeric, input the width of the image to create.

rtplot_name

Character, input the name of the RT adjustment image to create.

pcaplot_name

Character, input the name of the PCA image to create.

Author(s)

Jasmine Chong jasmine.chong@mail.mcgill.ca, Mai Yamamoto yamamoto.mai@mail.mcgill.ca, and Jeff Xia jeff.xia@mcgill.ca McGill University, Canada License: GNU GPL (>= 2)


simscr/metaboanalyst documentation built on Jan. 21, 2020, 12:13 a.m.