ordr (version 0.1.1)

conference: Confer inertia to factors of a 'tbl_ord' object

Description

Re-distribute inertia between rows and columns in an ordination.

Usage

recover_conference(x)
# S3 method for default
recover_conference(x)
get_conference(x)
revert_conference(x)
confer_inertia(x, p)

Value

recover_conference() returns the (statically implemented) distribution of inertia between the rows and the columns as stored in the model. confer_inertia() returns a tbl_ord with a specified distribution of inertia but the wrapped model unchanged. get_conference() returns the distribution currently conferred.

Arguments

x

A tbl_ord.

p

Numeric vector of length 1 or 2. If length 1, the proportion of the inertia assigned to the cases, with the remainder 1 - p assigned to the variables. If length 2, the proportions of the inertia assigned to the cases and to the variables, respectively.

Details

The inertia of a singular value decomposition \(X=UDV'\) consists in the squares of the singular values (the diagonal elements of \(D\)), and represents the variance, likened to the physical inertia, in the directions of the orthogonal singular vectors (the columns of \(U\) or of \(V\)). Biplots superimpose the projections of the rows and the columns of \(X\) onto these coordinate vectors, scaled by some proportion of the total inertia: \(UD^p\) and \(VD^q\). A biplot is balanced if \(p+q=1\). Read Orlov (2013) for more on conferring inertia in PCA.

recover_conference(), like the other recoverers, is an S3 method that is exported for convenience but not intended to be used directly.

Note: In case the "inertia" attribute is a rectangular matrix, one may only be able to confer it entirely to the cases (p = 1) or entirely to the variables (p = 0).

References

Orlov K (2013) Answer to "Algebra of LDA. Fisher discrimination power of a variable and Linear Discriminant Analysis". CrossValidated, accessed 2019-07-26. https://stats.stackexchange.com/a/83114/68743

See Also

Other generic recoverers: augmentation, recoverers, supplementation

Examples

# illustrative ordination: correspendence analysis of hair & eye data
haireye_ca <- ordinate(
  as.data.frame(rowSums(HairEyeColor, dims = 2L)),
  cols = everything(), model = MASS::corresp
)
print(haireye_ca)

# check distribution of inertia
get_conference(haireye_ca)
# confer inertia to rows, then to columns
confer_inertia(haireye_ca, "rows")
confer_inertia(haireye_ca, "columns")
# confer inertia symmetrically
(haireye_ca <- confer_inertia(haireye_ca, "symmetric"))
# check redistributed inertia
get_conference(haireye_ca)
# restore default distribution of inertia
revert_conference(haireye_ca)