R/create_tracelog.R

In richelbilderbeek/beastscriptr: 'BEAUti' from R

#' Create a \code{tracelog} object
#' @inheritParams default_params_doc
#' @return a \code{tracelog} object
#' @param filename
#'   name of the file to store the posterior traces.
#'   Use \link{NA} to use the filename \code{[alignment_id].log},
#'   where \code{alignment_id} is obtained using \link{get_alignment_id}
#' @examples
#' create_tracelog()
#' @author Richèl J.C. Bilderbeek
#' @export
create_tracelog <- function(
  filename = NA,
  log_every = 1000,
  mode = "autodetect",
  sanitise_headers = TRUE,
  sort = "smart"
) {
  tracelog <- list(
    filename = filename,
    log_every = log_every,
    mode = mode,
    sanitise_headers = sanitise_headers,
    sort = sort
  )
  check_tracelog(tracelog)
  tracelog
}