getExplanation: Retrieve the normalized 'explanation' of variance for each PC...

View source: R/misc.R

getExplanationR Documentation

Retrieve the normalized 'explanation' of variance for each PC as eigenvalues

Description

Returns the 'explanations' of variance as derived from the sdev component of the PC (principal components)

Usage

getExplanation(X, n = length(X$pick), asVariance = TRUE)

Arguments

X

the Tetramers R6 class object

n

the number of elements to return, by default the number of PCs

asVariance

if TRUE then use the variance (which is the eigenvalue) instead of the

Value

a vector of eigenvalues


BigelowLab/tetramers documentation built on April 3, 2022, 8:22 p.m.