lmwContributions: Summary of the contributions of each effect

View source: R/lmwContributions.R

lmwContributionsR Documentation

Summary of the contributions of each effect

Description

Reports the contribution of each effect to the total variance, but also the contribution of each principal component to the total variance per effect. Moreover, these contributions are summarized in a barplot. Only meaningful for ASCA and ASCA-E methods since the principal components are derived from the pure effect matrices.

Usage

lmwContributions(resLmwPcaEffects, nPC = 5)

Arguments

resLmwPcaEffects

A list corresponding to the output value of lmwPcaEffects.

nPC

The number of Principal Components to display.

Value

A list of:

totalContribTable

Table of the percentage of contribution of each effect to the total variance.

effectTable

Table of the variance percentage explained by each Principal Component in each model effect decomposition.

contribTable

Table of the variance percentage explained by each Principal Component of each effect reported to the percentage contribution of the given effect to the total variance.

combinedEffectTable

Equivalent of the EffectTable for combined effects.

plotTotal

Plot of the ordered contributions of TotalContribTable.

plotContrib

Plot of the ordered contributions of ContribTable.

Examples

data('UCH')
resLmwModelMatrix = lmwModelMatrix(UCH)
resLmwEffectMatrices = lmwEffectMatrices(resLmwModelMatrix)
resLmwPcaEffects = lmwPcaEffects(resLmwEffectMatrices, method="ASCA-E")

lmwContributions(resLmwPcaEffects)


bgovaerts/LMWiRe documentation built on Sept. 17, 2022, 12:32 a.m.