MDFCNorm: Maximal density fold change normalization

View source: R/MDFCNorm.R

MDFCNormR Documentation

Maximal density fold change normalization

Description

Sample normalization using maximal density fold change.

Usage

MDFCNorm(
  FeatureTable,
  IntThreshold = 0,
  SampleInCol = TRUE,
  output = FALSE,
  OutputNormFactors = FALSE,
  RunEvaluation = TRUE,
  bwOpt = NA
)

Arguments

FeatureTable

Data frame with features in row and samples in column (default).

IntThreshold

A numeric value indicating the feature intensity threshold. Feature is detected when its intensity larger than this value.

SampleInCol

TRUE if samples are in column. FALSE if samples are in row.

output

TRUE will output the result table in current working directory

OutputNormFactors

TRUE will print the normalization factors after normalization

RunEvaluation

TRUE will evaluate the normalization results by intragroup variation.

bwOpt

NA will automatically optimize the bandwidth. Use a numeric value to set the bandwidth and skip the optimization.

Details

FeatureTable contains measured or corrected signal intensities of metabolic features, with features in row and samples in column (default). The column names should be sample names, and the first row should be sample group names (e.g. control, case).
The first column should be unique feature identifiers. For group names, please use:
"RT" for retention time column;
"QC" for quality control samples between real samples (normal QC samples);
"blank" for blank samples;
"SQC_###" for serial QC samples with a certain loading amount. For example, SQC_1.0 means a serial QC sample with injection volume of 1.0 uL.
An example of FeatureTable is provided as TestingData in this package.

Value

This function will return a list that contains four items if RunEvaluation = TRUE: the normalized feature table, normalization factors, PRMAD of original data, and PRMAD of normalized data. The last two items will not be generated if RunEvaluation = FALSE

References

Yu, Huaxu, and Tao Huan. "MAFFIN: Metabolomics Sample Normalization Using Maximal Density Fold Change with High-Quality Metabolic Features and Corrected Signal Intensities." bioRxiv (2021).

Examples

MDFCNormedTable = MDFCNorm(TestingData)

Waddlessss/MAFFIN documentation built on Aug. 5, 2023, 8:10 p.m.