create_pff_mcmc: Create mcmc that has Peregrine friendly filenames

View source: R/create_pff_mcmc.R

create_pff_mcmcR Documentation

Create mcmc that has Peregrine friendly filenames

Description

Create mcmc that has Peregrine friendly filenames

Usage

create_pff_mcmc(
  chain_length = beautier::create_mcmc()$chain_length,
  store_every = beautier::create_mcmc()$store_every,
  pre_burnin = beautier::create_mcmc()$pre_burnin,
  n_init_attempts = beautier::create_mcmc()$n_init_attempts,
  sample_from_prior = beautier::create_mcmc()$sample_from_prior,
  tracelog = beautier::create_tracelog(filename = peregrine::get_pff_tempfile()),
  screenlog = beautier::create_screenlog(filename = ""),
  treelog = beautier::create_treelog(filename = peregrine::get_pff_tempfile())
)

Arguments

chain_length

length of the MCMC chain

store_every

number of states the MCMC will process before the posterior's state will be saved to file. Use -1 or NA to use the default frequency.

pre_burnin

number of burn in samples taken before entering the main loop

n_init_attempts

number of initialization attempts before failing

sample_from_prior

set to TRUE to sample from the prior

tracelog

a tracelog, as created by create_tracelog

screenlog

a screenlog, as created by create_screenlog

treelog

a treelog, as created by create_treelog

Author(s)

Giovanni Laudanno, Richèl J.C. Bilderbeek


richelbilderbeek/peregrine documentation built on Jan. 3, 2024, 7:42 p.m.