rescaleVariance: Scale phenotype component.

Description Usage Arguments Value Examples

View source: R/createphenotypeFunctions.R

Description

The function scales the specified component such that the average column variance is equal to the user-specified proportion of variance.

Usage

1
rescaleVariance(component, propvar)

Arguments

component

[N x P] Phenotype matrix [double] where [N] are the number of samples and P the number of phenotypes

propvar

Number [double] specifying the proportion of variance that should be explained by this phenotype component

Value

If propvar != 0, a named list with the [N x P] matrix of the scaled component (component) and its scale factor [double] (scale_factor) else returns NULL

Examples

1
2
x <- matrix(rnorm(100), nc=10)
x_scaled <- rescaleVariance(x, propvar=0.4)

PhenotypeSimulator documentation built on Jan. 8, 2018, 1:03 a.m.