R/quarto_funs.R

In WhiteJP/jpw: Useful tidbits

#' Render Quarto document to another directory
#'
#' Currently `quarto::quarto_render()` does not allow to render quarto to another
#' directory. This function creates a temporary directory within which to render
#' the .qmd doc, then copies files to the output directory.
#'
#' @param qmd_file string. file path for input `.qmd` file
#' @param out_dir string. path to output directory in which to save .qmd output
#' @param render_in_temp logical. whether to render in a temporary directory or in
#'  the same directory as the input file. Defaults to `FALSE`.
#' @param overwrite logical. whether to overwrite existing files in the output
#'  directory.
#' @param ... passed to quarto_render
#' @returns Invisibly returns character vector with output file path(s). Mainly
#' called for side effects -- rendering quarto in new directory.
#'
#' @export
quarto_render_to_dir <- function(
    qmd_file,
    out_dir,
    render_in_temp = FALSE,
    overwrite = TRUE,
    ...) {

  # set directory to execute
  if(render_in_temp){
    render_dir <- tempfile()
    fs::dir_create(render_dir)
    render_file <- fs::path(render_dir, fs::path_file(qmd_file))
    fs::file_copy(qmd_file, render_file)

  } else {
    render_dir <- fs::path_dir(qmd_file)
    render_file <- qmd_file
  }

  # Render
  quarto::quarto_render(input = render_file, ...)

  # Move output files to output directory, and delete in render directory
  output_paths <- handle_output_files_and_dirs(
    render_dir, out_dir, render_file, overwrite, render_in_temp
  )

  invisible(output_paths)
}


# Helpers -----------------------------------------------------------------

exclude_r_files_regex <- function(out_name) {
  base_name <- fs::path_ext_remove(out_name)
  paste0(
    "(?i)",  # Case insensitive
    "(?!",   # Negative lookahead start
    ".*\\.",  # Any characters followed by a dot
    "(qmd|rmd|rmarkdown|r|rdata|rds)$",  # R-related extensions
    ")",     # Negative look-ahead end
    ".*",    # Any characters
    base_name  # The base name of the output file
  )
}

handle_output_files_and_dirs <- function(render_dir, out_dir, render_file, overwrite = FALSE, render_in_temp = FALSE) {
  # List all files and directories
  output_items <- fs::dir_ls(
    render_dir,
    regexp = exclude_r_files_regex(fs::path_file(render_file)),
    type = "any",
    perl = TRUE
  )

  # Copy files and directories to output dir
  for (item in output_items) {
    dest_path <- fs::path(out_dir, fs::path_rel(item, render_dir))
    if (fs::is_file(item)) {
      fs::file_copy(item, dest_path, overwrite = overwrite)
    } else if (fs::is_dir(item)) {
      fs::dir_copy(item, dest_path, overwrite = overwrite)
    }
  }

  # Delete original files and directories
  if (render_in_temp) {
    fs::dir_delete(render_dir)
  } else {
    for (item in output_items) {
      if (fs::is_file(item)) {
        fs::file_delete(item)
      } else if (fs::is_dir(item)) {
        fs::dir_delete(item)
      }
    }
  }

  output_items
}