R/create_file_marg_liks.R

Defines functions create_marg_liks_file

Documented in create_marg_liks_file

#' @title Creates file containing marginal loglikelihoods
#' @description Creates file containing marginal loglikelihoods
#' @inheritParams default_params_doc
#' @return the name of the saved file
#' @author Giovanni Laudanno
#' @aliases create_file_marg_liks create_marg_liks_file
#' @export create_file_marg_liks create_marg_liks_file
create_file_marg_liks <- create_marg_liks_file <- function(
  project_folder_name = getwd()
) {

  # create the dataframe
  marg_liks <- collect_marg_liks(project_folder_name) # nolint internal function

  # save output
  results_folder <- get_results_path(project_folder_name) # nolint
  # No warning if folder already exists
  dir.create(results_folder, showWarnings = FALSE)

  marg_liks_filename <- file.path(
    results_folder,
    "marg_liks.csv"
  )
  utils::write.csv(x = marg_liks, file = marg_liks_filename)

  # return file name
  marg_liks_filename
}
richelbilderbeek/razzo documentation built on March 10, 2021, 1:17 p.m.