R/match_ordi_method.R

In krisrs1128/mvarVis: Visualize multivariate analysis results.

#' @title Search Vegan and ade4 for matching method
#'
#' @description Given a character string describing an ordination method
#'  from ade4 or vegan, return the actual function for that method.
#'
#' @param A string describing the function to return. The currently accepted
#'  strings, along with the functions they return, are
#'    pca: dudi.pca
#'    pco: dudi.pco
#'    acm: dudi.acm
#'    coa: dudi.coa
#'    fpca: dudi.fpca
#'    hillsmith: dudi.hillsmith
#'    mix: dudi.mix
#'    nsc: dudi.nsc
#'    vegan_cca: cca, from vegan
#'  and any other string that exactly matches a function in ade4 or vegan.
#'
#' @return ordi_method The function from either ade4 or vegan giving the
#'  desired function.
#'
#' @importFrom ade4 dudi.pca dudi.pco dudi.acm dudi.coa dudi.fpca dudi.hillsmith
#'    dudi.mix dudi.nsc dpcoa
#' @importFrom vegan cca
#' @importFrom FactoMineR PCA CA MFA
match_ordi_method <- function(method) {
  # determine the function to be called
  paste_dudi <- c("pco", "acm", "coa", "fpca","hillsmith", "mix", "nsc")
  rename_methods <- c("vegan_cca", "ade4_pca", "factominer_pca")
  if(method %in% paste_dudi) {
    # Methods that need to be called as dudi."name"
    ordi_method <- get(paste0("dudi.", method))
  } else if(method %in% rename_methods) {
    ordi_method <- switch(method,
                          "vegan_cca" = vegan::cca,
                          "ade4_pca" = ade4::dudi.pca,
                          "factominer_pca" = FactoMineR::PCA)
  } else {
    # Methods that can be called directly
    ordi_method <- get(method)
  }
  ordi_method
}