ordi_wrapper: Wrapper for vegan / ade4 / factominer ordination methods

Description Usage Arguments Value

View source: R/ordi_wrapper.R

Description

Given data X and a string describing a method in ade4, or factominer, or vegan, return the corresponding ordination object from those packages.

Usage

1
ordi_wrapper(X, method = "ade4_pca", dist_method = "euclidean", ...)

Arguments

X

Either a data frame, a distance object, a list of both a data frame and a distance, a formula and a data frame, or a list of data frames, depending on the desired method. pcm, acm, coa, fca, fpca, hillsmith, mix, and nsc require the raw data frame. pco, isomap, and metaMDS can take either a data.frame or a dist. vegan_cca and rda require a list whose first element is a formula and whose second element is a data set containing the constraining variables, as in the usual cca function in vegan. dpcoa requires a list whose first element is a data frame and whose second element is a distance between the rows on that data frame. CCorA and procuste require a list of data frames. @param method The method among those listed above that will perform the required ordination. @param dist_method If a distance matrix is used by the specified method and X is not a distance object, we will call vegdist on the X using this string as the distance.

Value

The result of a call to the specified method, in the original ade4, factominer, or vegan classes.


krisrs1128/mvarVis documentation built on Oct. 13, 2019, 11:14 p.m.