block_scale: Scales a block of data to have a certain variance per sample

Description Usage Arguments Value

View source: R/local_preprocessing_functions.R

Description

Scales a block of data to have a certain variance per sample

Usage

1
block_scale(input_data, settings = list(block_variance = 1))

Arguments

input_data

A matrix containing data. The rows indicate the samples, the columns indicate the variables.

settings

A list with a single named element "block_variance". When block_variance is set, the supplied value is used for scaling, otherwise a value of 1 is used.

Value

A named list with "preprocessed_data": the scaled input_data matrix, and "settings", which is equal to the settings input parameter when set, and otherwise contains the calculated and used block_std.


GeertPostma/pathmodelr documentation built on Oct. 5, 2021, 4:17 p.m.