Description Usage Arguments Value
This function is a wrapper for the other "taxa_" functions that sequences through unique values within specified columns. The intent is to provide the ability to quickly calculate metrics for a large number of taxa without having to call a "taxa_" function for each taxon of interest.
1 2 3 4 5 6 7 8 9 10 11 12 |
.dataframe |
A data frame where each row should represent the number of individuals enumerated for a single taxon collected during a single sampling event. |
.key_col |
One unquoted column name that represents a key (i.e., unique ID) for a sampling event for which to group (i.e., aggregate) the data. |
.counts_col |
One unquoted column name that represents taxonomic counts. |
.filter_cols_vec |
A quoted vector of column names for which the function will sequence through each unique value to perform the specified .job. |
.group_col |
One unquoted column name that represents a taxomic rank or group of interest. |
.unnest_col |
One unqouted column name that represents nested data. If this column is NULL (default), then the data will not be unnested. |
.job |
A character string specifying the metric of interest. Below is a list of exceptable inputs:
|
.exclude_pattern |
a character vector of patterns found in taxonomic names that should be excluded from the sequence. This argument does not filter these taxa from the data during calculations (use the .filter argument for that purpose), but instead reduces the number of metrics that will be calculated by removing taxa that contain the specified patter. For example, .exclude_pattern = "unidentified" would remove any taxonomic name that contains "unidentified" from the iterative taxa sequence (i.e., no metrics will be returned for taxa that contain this pattern). Multiple patterns can be supplied within a character vector (e.g., .exclude_pattern = c("unidentified", "hyallella"). |
.base_log |
The base log value used during the calculation of Shannon Diversity index ("shannon") or Effective Shannon Diversity ("effective_shannon"). The default value is two. |
.q |
The exponent used during the calculation of Hill Numbers ("hill") and Renyi Entropy ("renyi"). |
A data frame where each column represents numeric metric values.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.