NormalizeMets (version 0.25)

LogTransform: Log transformation

Description

Log transform a metabolomics feature data matrix.

Usage

LogTransform(featuredata, base = exp(1), saveoutput = FALSE,
  outputname = "log.results", zerotona = FALSE)

Arguments

featuredata

featuredata A data frame in the featuredata format. This is a dataframe with metabolites in columns and samples in rows. Unique sample names should be provided as row names. See NormalizeMets Vignette for details.

base

The base with respect to which logarithms are computed. The default computes the natural logarithm.

saveoutput

A logical indicating whether the output should be saved as a .csv file.

outputname

The name of the output file if the output has to be saved.

zerotona

A logical indicating whether any zeros should be converted to missing prior to log transforming. By default, this is set to FALSE.

Value

The result is an object of class alldata.

Examples

# NOT RUN {
    data(alldata_eg)
    lg <- LogTransform(alldata_eg$featuredata)
    dataview(lg$featuredata)

# }