select_candidate_evidences: Select the evidences for candidate experiments

View source: R/select_candidate_evidences.R

select_candidate_evidencesR Documentation

Select the evidences for candidate experiments

Description

Select the evidences for candidate experiments

Usage

select_candidate_evidences(
  experiments = list(create_test_experiment()),
  marg_liks = create_test_marg_liks()
)

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

marg_liks

a data frame with marginal likelihoods/evidences. A test data frame can be created by create_test_marg_liks

Value

the evidences for the candidate experiments, as a numeric vector

Author(s)

Richèl J.C. Bilderbeek

Examples

if (beautier::is_on_ci() && rappdirs::app_dir()$os != "win") {
  experiment_1 <- create_test_gen_experiment()
  experiment_2 <- create_test_cand_experiment()
  experiments <- list(experiment_1, experiment_2)

  # Experiments must have different inference models
  experiments[[1]]$inference_model$site_model <- 
    beautier::create_gtr_site_model()

  select_candidate_evidences(
    experiments = experiments,
    marg_liks = create_test_marg_liks()
  )
}

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