pir_runs: Do multiple pirouette runs

View source: R/pir_runs.R

pir_runsR Documentation

Do multiple pirouette runs

Description

This is a simple convenience functions: supply as much phylogenies as pirouette parameter sets. For each phylogeny-parameters pair, pir_run is called.

Usage

pir_runs(phylogenies, pir_paramses)

Arguments

phylogenies

a list of phylogenies, each phylogeny being of class phylo

pir_paramses

a list of pirouette parameters, each element created by create_pir_params.

Value

a list of pir_run outputs.

Author(s)

Richèl J.C. Bilderbeek

See Also

  • Use pir_run for a single pirouette run.

  • Use pir_plots to plot the output of this function.

  • Use check_pir_out on each list element, to check its validity.

Examples

if (beautier::is_on_ci() && beastier::is_beast2_installed()) {

  pir_paramses <- list()
  pir_paramses[[1]] <- create_test_pir_params()
  pir_paramses[[2]] <- create_test_pir_params()

  phylogenies <- list()
  phylogenies[[1]] <- ape::read.tree(text = "((A:2, B:2):1, C:3);")
  phylogenies[[2]] <- ape::read.tree(text = "((A:1, B:1):2, C:3);")

  pir_outs <- pir_runs(
    phylogenies = phylogenies,
    pir_paramses = pir_paramses
  )
  for (pir_out in pir_outs) {
    check_pir_out(pir_out)
  }
}

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