create_tracelog: Create a 'tracelog' object

View source: R/create_tracelog.R

create_tracelogR Documentation

Create a tracelog object

Description

Create a tracelog object

Usage

create_tracelog(
  filename = NA,
  log_every = 1000,
  mode = "autodetect",
  sanitise_headers = TRUE,
  sort = "smart"
)

Arguments

filename

name of the file to store the posterior traces. Use NA to use the filename [alignment_id].log, where alignment_id is obtained using get_alignment_id

log_every

number of MCMC states between writing to file

mode

mode how to log. Valid values are the ones returned by get_log_modes

sanitise_headers

set to TRUE to sanitise the headers of the log file

sort

how to sort the log. Valid values are the ones returned by get_log_sorts

Value

a tracelog object

Author(s)

Richèl J.C. Bilderbeek

Examples

create_tracelog()

beautier documentation built on Nov. 2, 2023, 5:08 p.m.