Learn R Programming

metricTester (version 1.3.6)

defineMetrics: Output all metrics as a list of named functions

Description

Creates a list of named functions, each of which accept a metrics.input object

Usage

defineMetrics()

Arguments

Value

A list of named functions

Details

All of the functions we calculated for our manuscript are included in this function. To add additional functions, they can either be defined on the fly or, to permanently include a new metric in all downstream simulations, it can be included here. The function needs to be included with a name, and it must accept a metrics.input as input. If the function needs additional elements not included in that input, then the prepData function must also be revised. Currently MRD references the non-abundance-weighted version of the function. This is simply so calcField knows how to handle the results downstream. Reminder to modify that function if abundance-weighted MRD is to be implemented here.

References

Miller, E. T., D. R. Farine, and C. H. Trisos. 2016. Phylogenetic community structure metrics and null models: a review with new methods and software. Ecography DOI: 10.1111/ecog.02070

Examples

Run this code
# NOT RUN {
defineMetrics()
# }

Run the code above in your browser using DataLab