Learn R Programming

metricTester (version 1.3.6)

checkNulls: Confirm that the null model functions are in suitable format

Description

Utility function. Creates a list of null models, either those defined in defineNulls or a named list of null model functions.

Usage

checkNulls(x, new_ = FALSE)

Arguments

x

Optional. If not provided, defines the nulls as those in defineNulls. Else either a character vector or a named list of functions, depending on whether new_ is set to TRUE or FALSE. See runNulls.

new_

Whether or not new nulls are being defined on the fly. Default is FALSE. Set to TRUE if a new null is being used.

Value

A list of functions.

Details

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

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 {
checkNulls(names(defineNulls()))
# }

Run the code above in your browser using DataLab