check_experiments: Checks if the argument is a list of one or more pirouette...

In richelbilderbeek/pirouette: Create a Bayesian Posterior from a Phylogeny

Checks if the argument is a list of one or more pirouette experiments.

Description

Will stop if not. A valid pirouette experiment can be created by create_experiment.

Usage

check_experiments(experiments)

Arguments

experiments

a list of one or more pirouette experiments, as can be created by create_experiment. If more than one experiment is provided and a "generative" experiment is part of them, the "generative" one has to be the first in the list. See also: Use check_experiments to check the list of experiments for validity Use create_all_experiments to create experiments with all combinations of tree model, clock model and tree priors Use create_all_bd_experiments to create experiments with all combinations of tree model, clock model and tree priors, except for only using birth-death tree priors Use create_all_coal_experiments to create all experiments with all combinations of tree model, clock model and tree priors, except for only coalescent tree priors Use shorten_experiments to shorten the run time of the list of experiments

Value

nothing. Will stop if not

Author(s)

Richèl J.C. Bilderbeek

See Also

Use check_experiment to check if an object is one valid experiment

Examples

if (beautier::is_on_ci()) {

  # Check cleanup by other functions
  beastier::check_empty_beaustier_folders()
  check_experiments(list(create_test_experiment()))

  if (rappdirs::app_dir()$os != "win") {
    experiments <- list(
      create_test_experiment(),
      create_test_cand_experiment()
    )
    # Experiments must have different inference models
    experiments[[1]]$inference_model$site_model <-
      beautier::create_gtr_site_model()

    check_experiments(experiments)
  }
}

richelbilderbeek/pirouette documentation built on Oct. 18, 2023, 3:09 p.m.