Skip to contents

Create a treelog object

Source: R/create_treelog.R
create_treelog.Rd

Create a treelog object

Usage

create_treelog(
  filename = "$(tree).trees",
  log_every = 1000,
  mode = "tree",
  sanitise_headers = FALSE,
  sort = "none"
)

Arguments

filename

name of the file to store the posterior trees

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 `treelog`, as can be checked by check_treelog

Author

Richèl J.C. Bilderbeek

Examples

check_empty_beautier_folder()

create_treelog()
#> $filename
#> [1] "$(tree).trees"
#> 
#> $log_every
#> [1] 1000
#> 
#> $mode
#> [1] "tree"
#> 
#> $sanitise_headers
#> [1] FALSE
#> 
#> $sort
#> [1] "none"
#> 

check_empty_beautier_folder()