mean_centre: Mean centre

Description Usage Arguments Value Examples

View source: R/mean_centre_class.R

Description

The mean sample is subtracted from all samples in the data matrix. The features in the centred matrix all have zero mean.

Usage

1
mean_centre(mode = "data", ...)

Arguments

mode

(character) Mode of action. Allowed values are limited to the following:

  • "data": Centring is applied to the data block.

  • "sample_meta": Centring is applied to the sample_meta block.

  • "both": Centring is applied to both the data and the sample_meta blocks.

The default is "data".

...

Additional slots and values passed to struct_class.

Value

A mean_centre object.

Examples

1

structToolbox documentation built on Nov. 8, 2020, 6:54 p.m.