Return names of data in taxonomy() or taxmap()

Return the names of data that can be used with functions in the taxa package that use non-standard evaluation (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)

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.

Value

character

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)
#>            taxon_names              taxon_ids          taxon_indexes 
#>          "taxon_names"            "taxon_ids"        "taxon_indexes" 
#>        classifications            n_supertaxa          n_supertaxa_1 
#>      "classifications"          "n_supertaxa"        "n_supertaxa_1" 
#>              n_subtaxa            n_subtaxa_1               n_leaves 
#>            "n_subtaxa"          "n_subtaxa_1"             "n_leaves" 
#>             n_leaves_1            taxon_ranks                is_root 
#>           "n_leaves_1"          "taxon_ranks"              "is_root" 
#>                is_stem              is_branch                is_leaf 
#>              "is_stem"            "is_branch"              "is_leaf" 
#>           is_internode                  n_obs                n_obs_1 
#>         "is_internode"                "n_obs"              "n_obs_1" 
#>         data$info$name       data$info$n_legs    data$info$dangerous 
#>                 "name"               "n_legs"            "dangerous" 
#>        data$abund$code   data$abund$sample_id       data$abund$count 
#>                 "code"            "sample_id"                "count" 
#> data$abund$taxon_index      data$phylopic_ids             data$foods 
#>          "taxon_index"         "phylopic_ids"                "foods" 
#>         funcs$reaction 
#>             "reaction" 

# Dont include the names of automatically included functions.
all_names(ex_taxmap, builtin_funcs = FALSE)
#>         data$info$name       data$info$n_legs    data$info$dangerous 
#>                 "name"               "n_legs"            "dangerous" 
#>        data$abund$code   data$abund$sample_id       data$abund$count 
#>                 "code"            "sample_id"                "count" 
#> data$abund$taxon_index      data$phylopic_ids             data$foods 
#>          "taxon_index"         "phylopic_ids"                "foods" 
#>         funcs$reaction 
#>             "reaction"