nroot_transform: nth root transform

View source: R/nroot_transform_class.R

nroot_transformR Documentation

nth root transform

Description

All values in the data matrix are transformed by raising them to the power of 1/n.

Usage

nroot_transform(root = 2, ...)

Arguments

root

(numeric) The nth root used for the transform. The default is 2.

...

Additional slots and values passed to struct_class.

Value

A nroot_transform object with the following output slots:

transformed (DatasetExperiment) A DatasetExperiment object containing the nth root transformed data.

Inheritance

A nroot_transform object inherits the following struct classes:

⁠[nroot_transform]⁠ >> ⁠[model]⁠ >> ⁠[struct_class]⁠

Examples

M = nroot_transform(
      root = 2)

M = nroot_transform()

computational-metabolomics/structtoolbox documentation built on Feb. 9, 2024, 8:19 a.m.