check_pir_out: Checks if the argument is a valid pirouette parameter set.

View source: R/check_pir_out.R

check_pir_outR Documentation

Checks if the argument is a valid pirouette parameter set.

Description

Will stop if not. A valid pirouette parameter set can be created by create_pir_params.

Usage

check_pir_out(pir_out)

Arguments

pir_out

the output of pir_run

Details

A pir_out contains:

  1. tree true or twin tree

  2. inference_model generative or candidate

  3. inference_model_weight

  4. site_model the site model name

  5. clock_model the clock model name

  6. tree_prior the tree model name

  7. error_1, error_2, etcetera: inference errors

Value

nothing. Will stop if not

Author(s)

Richèl J.C. Bilderbeek

Examples

check_pir_out(create_test_pir_run_output())

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