pirouette (version 1.6.9)

check_error_fun: Check that the error_fun is valid.

Description

Will stop if not.

Usage

check_error_fun(error_fun)

Value

nothing

Arguments

error_fun

function that determines the error between a given phylogeny and a the trees in a Bayesian posterior. The function must have two arguments:

• the one given phylogeny, of class phylo

• one or more posterior trees, of class multiphylo

The function must return as many errors as there are posterior trees given. The error must be lowest between identical trees. Example functions are:

• get_gamma_error_fun: use the absolute difference in gamma statistic

• get_nltt_error_fun: use the nLTT statistic

Author

Richèl J.C. Bilderbeek

Examples

# Check cleanup by other functions
beastier::check_empty_beaustier_folders()

check_error_fun(get_gamma_error_fun())
check_error_fun(get_nltt_error_fun())