supplementation: Supplement 'tbl_ord' objects with new data

supplementationR Documentation

Supplement 'tbl_ord' objects with new data

Description

These functions attach supplementary rows or columns to an ordination object.

Usage

recover_supp_rows(x)

## Default S3 method:
recover_supp_rows(x)

recover_supp_cols(x)

## Default S3 method:
recover_supp_cols(x)

Arguments

x

An object of class 'tbl_ord'.

Details

The ⁠recover_supp_*()⁠ S3 methods produce matrices of supplemental rows or columns of a tbl_ord object from the object itself. The motivating example is linear discriminant analysis, which produces a natural biplot of class discriminant centroids and variable axes but is usually supplemented with case discriminant scores. The supplementary values are augmented with an .element column whose value indicates their source and can be incorporated into a tidied form. If no supplementary rows of a factor are produced, the functions return NULL.

Value

Matrices having the same numbers of columns as returned by recover_rows() and recover_cols(), or else NULL.

See Also

Other generic recoverers: augmentation, conference, recoverers


corybrunson/ordr documentation built on Feb. 15, 2024, 9:28 p.m.