checkBetaMetrics: Confirm that the metric functions are in suitable format

In eliotmiller/metricTester: Test Metric and Null Model Statistical Performance

Description

Utility function. Creates a list of functions, either those defined in defineMetrics or a named list of metric functions.

Usage

checkBetaMetrics(x, new_ = FALSE)

Arguments

x	Optional. If not provided, defines the metrics as those in defineBetaMetrics. Else either a character vector or a named list of functions, depending on whether new_ is set to TRUE or FALSE. See calcBetaMetrics.
new_	Whether or not new metrics are being defined on the fly. Default is FALSE. Set to TRUE if a new metric is being used.

Details

A few quick checks to confirm the metric functions are input in suitable format.

Value

A list of functions.

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

checkBetaMetrics(names(defineBetaMetrics()))

eliotmiller/metricTester documentation built on Dec. 16, 2019, 12:39 p.m.