R/batch_functions.R

In bramzandbelt/irmass: Independent Race Model Analysis of Selective Stopping

# ==============================================================================

#' Batch-render analysis notebooks
#'
#' @param notebook_file filename of the template notebook to be run
#' @param notebook_dir directory where the template notebook resides
#' @param reports_dir directory where reports are written
#' @param params_tibble tibble of parameter values with which to run the notebooks
#' @param force whether or note to rerun a notebook when it exists
#' @export
render_notebook <- function(notebook_file, notebook_dir = "analysis", reports_dir = "reports", params_tibble, force = FALSE) {

  # Check if notebook_dir and reports_dir exist, create them if they don't
  irmass::check_dir(all_dirs = c(notebook_dir, reports_dir))

  # Parse notebook file
  notebook_path <-
    file.path(notebook_dir, notebook_file)
  notebook_fileparts <-
    stringr::str_split(notebook_file, pattern = "\\.", simplify = TRUE)
  notebook_filename <-
    notebook_fileparts[1:length(notebook_fileparts) - 1]
  notebook_ext <-
    notebook_fileparts[-1]

  # Assertions
  assertthat::assert_that(file.exists(notebook_path),
                          msg = stringr::str_c("Notebook '",
                                               notebook_path,
                                               "' does not exist.")
  )

  report_file <- stringr::str_c(notebook_filename, ".html")
  report_path <- file.path(reports_dir, report_file)

  # Render notebook only if report does not exist or if forced
  if (!file.exists(report_path) | force) {
    tryCatch(rmarkdown::render(input = notebook_path,
                               output_dir = reports_dir,
                               output_file = report_file,
                               knit_root_dir =
                                 rprojroot::find_root(rprojroot::has_file("DESCRIPTION"))
    ),
    error = function(e) {
      message(e)
      message("Failed to render notebook")

    }
    )

  }

}