modScale: Scale Data by Factor Range

Description Usage Arguments Details Value

View source: R/3-mod.R

Description

modScale scales a data set by making all sample vectors have the same total sum, then multiplying each sample vector by a scale factor.

Usage

1
modScale(object, alpha = 0, uniform = TRUE)

Arguments

object

An ExprsArray object. The object that should undergo a replication of the feature selection history.

alpha

An integer. The maximum range of scale factors used for scaling if uniform = TRUE. The standard deviation of the scale factors if uniform = FALSE. See Details.

uniform

A boolean. Toggles whether to draw scale factors from a uniform distribution or a normal distribution.

Details

If uniform = TRUE, scale factors are randomly sampled from the uniform distribution (0, alpha) + 1. Otherwise, scale factors are randomly sampled from the normal distribution with a mean of 0 and standard deviation of alpha. When using the normal distribution, these scale factors are transformed by taking the absolute value then adding one. For this reason, data are always unscaled when alpha = 0.

Value

An ExprsArray object.


tpq/exprso documentation built on July 27, 2019, 8:44 a.m.