Skip to contents

Programmatic access to the list of available ordination methods, and their associated functions.

Usage

list_ordinations(
  val = c("data.frame", "list", "func", "id", "name", "input"),
  nm = c(NA, "id", "name"),
  input = NULL
)

match_ordination(method, input = NULL)

Arguments

val

Sets the return value for this function call. See "Value" section below. Default: "data.frame"

nm

What value to use for the names of the returned object. Default is "id" when val is "list" or "func", otherwise the default is NA (no name).

input

Filter by the kind of data the method takes: "dist" for distances. Default: NULL (no filtering).

method

The name of an ordination method to search for. Supports partial matching. All non-alpha characters are ignored.

Value

match_ordination()

A list with the following elements.

  • name : Method name, e.g. "Principal Coordinates Analysis"

  • id : Method ID - also the name of the function, e.g. "pcoa"

  • input : The kind of data the method takes, e.g. "dist".

  • func : The function for this method, e.g. ecodive::pcoa

  • params : Formal args for func, e.g. c("dm", "k", "cpus")

list_ordinations()

The returned object's type and values are controlled with the val and nm arguments.

  • val = "data.frame" : The data.frame from which the below options are sourced.

  • val = "list" : A list of objects as returned by match_ordination() (above).

  • val = "func" : A list of functions.

  • val = "id" : A character vector of method IDs.

  • val = "name" : A character vector of method names.

  • val = "input" : A character vector of the kinds of data each method takes.

If nm is set, then the names of the vector or list will be the method ID (nm="id") or name (nm="name"). When val="data.frame", the names will be applied to the rownames() property of the data.frame.

Examples


    # A data.frame of all available methods.
    list_ordinations()
#>                                  name   id input
#> 1 Non-metric Multidimensional Scaling nmds  dist
#> 2      Principal Coordinates Analysis pcoa  dist

    # Find the method for 'MDS'.
    m <- match_ordination('MDS')
    m$id
#> [1] "pcoa"