R/rmdx_pdf.R

In drdsdaniel/Rmdx: RMarkdown Extra Formats

#' Rmdx PDF document format
#'
#' \lifecycle{experimental}
#'
#' This format is based in \code{\link[bookdown]{pdf_document2}}.
#'
#' @param toc logical See \code{\link[rmarkdown]{pdf_document}}
#' @param latex_engine character See \code{\link[rmarkdown]{pdf_document}}
#' @param ... arguments to be passed to \code{\link[bookdown]{pdf_document2}}
#'
#' @return An R Markdown output format object to be passed to \code{\link[rmarkdown]{render}}
#' @export
#'
#' @examples
#' \dontrun{
#' ---
#' ...
#' output: Rmdx::rmdx_pdf
#' ---
#' }
rmdx_pdf = function(toc = TRUE, latex_engine = 'xelatex', ...) {
  # locations of resource files in the package
  pkg_resource = function(...) {
    system.file(..., package = "Rmdx")
  }

  preamble = pkg_resource("resources/pdf/preamble.tex")

  if (!requireNamespace("bookdown", quietly = TRUE)) {
    stop("Package \"bookdown\" needed for this function to work. Please install it.", call. = FALSE)
  }

  bookdown::pdf_document2(
    toc = toc,
    latex_engine = latex_engine,
    includes = rmarkdown::includes(in_header =  preamble),
    ...
  )
}