create_std_pir_paramses: Create a number of standard 'pir_params'

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

Create a number of standard pir_params

Description

Create a number of standard pir_params

Usage

create_std_pir_paramses(
  n,
  folder_name = rappdirs::user_cache_dir(),
  rng_seed = 314,
  crown_age = 10,
  sequence_length = 1000,
  mutation_rate = 1/crown_age,
  os = rappdirs::app_dir()$os
)

Arguments

n	number of pir_params
folder_name	name of the main folder
rng_seed	a random number generator seed
crown_age	the fixed crown age of the posterior. Set to NA to let it be estimated
sequence_length	the length of each DNA sequence in an alignment
mutation_rate	the mutation rate per base pair per time unit. Use check_mutation_rate to check if a mutation rate is valid.
os	name of the operating system, can be mac, unix or win. Use check_os if the operating system is valid.

Value

a list or pir_params, dubbed a pir_paramses. Use check_pir_paramses to check this list for validity.

Examples

  pir_paramses <- create_std_pir_paramses(n = 2)
  check_pir_paramses(pir_paramses)

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