R/rename_inference_model_filenames.R

In richelbilderbeek/beastscriptr: 'BEAUti' from R

#' Rename the filenames in an inference model
#' @inheritParams default_params_doc
#' @return an inference model with the renamed filenames
#' @examples
#' check_empty_beautier_folder()
#'
#' inference_model <- create_inference_model()
#' inference_model$mcmc$tracelog$filename <- "trace.log"
#' inference_model$mcmc$screenlog$filename <- "screen.log"
#' inference_model$mcmc$treelog$filename <- "tree.log"
#' inference_model$tipdates_filename <- "tipdates.csv"
#'
#' # Nah, put the files in a folder
#' inference_model <- rename_inference_model_filenames(
#'   inference_model = inference_model,
#'   rename_fun = get_replace_dir_fun("/home/john")
#' )
#'
#' # Nah, put the files in anoth folder
#' inference_model <- rename_inference_model_filenames(
#'   inference_model = inference_model,
#'   rename_fun = get_replace_dir_fun("/home/doe")
#' )
#'
#' # Nah, store the files locally
#' rename_inference_model_filenames(
#'   inference_model = inference_model,
#'   rename_fun = get_remove_dir_fun()
#' )
#'
#' check_empty_beautier_folder()
#' @export
rename_inference_model_filenames <- function( # nolint long function name indeed
  inference_model,
  rename_fun
) {
  check_inference_model(inference_model)
  check_rename_fun(rename_fun)

  # MCMC
  inference_model$mcmc <- rename_mcmc_filenames(
    inference_model$mcmc,
    rename_fun = rename_fun
  )

  # tipdates
  inference_model$tipdates_filename <- rename_fun(
    inference_model$tipdates_filename
  )

  inference_model
}