metacoder (version 0.3.7)

all_names: Return names of data in [taxonomy()] or [taxmap()]

Description

Return the names of data that can be used with functions in the taxa package that use [non-standard evaluation](http://adv-r.had.co.nz/Computing-on-the-language.html) (NSE), like [filter_taxa()].

obj$all_names(tables = TRUE, funcs = TRUE,
  others = TRUE, warn = FALSE)
all_names(obj, tables = TRUE, funcs = TRUE,
  others = TRUE, warn = FALSE)

Value

`character`

Arguments

obj

([taxonomy()] or [taxmap()]) The object containing taxon information to be queried.

tables

This option only applies to [taxmap()] objects. If `TRUE`, include the names of columns of tables in `obj$data`

funcs

This option only applies to [taxmap()] objects. If `TRUE`, include the names of user-definable functions in `obj$funcs`.

others

This option only applies to [taxmap()] objects. If `TRUE`, include the names of data in `obj$data` besides tables.

builtin_funcs

This option only applies to [taxmap()] objects. If `TRUE`, include functions like [n_supertaxa()] that provide information for each taxon.

warn

option only applies to [taxmap()] objects. If `TRUE`, warn if there are duplicate names. Duplicate names make it unclear what data is being referred to.

See Also

Other NSE helpers: data_used, get_data(), names_used

Examples

# Get the names of all data accesible by non-standard evaluation
all_names(ex_taxmap)

# Dont include the names of automatically included functions.
all_names(ex_taxmap, builtin_funcs = FALSE)