R/rmdx_docx.R

In drdsdaniel/Rmdx: RMarkdown Extra Formats

#' Rmdx DOCX document format
#'
#' \lifecycle{experimental}
#'
#'  This format is based in \code{\link[officedown]{rdocx_document}}.
#'
#' @param toc [logical]: See \code{\link[rmarkdown]{word_document}}
#' @param highlight [character]: See \code{\link[rmarkdown]{html_document}} highlight argument
#' @param ... other arguments passed to \code{\link[officedown]{rdocx_document}}
#'
#' @return An R Markdown output format object to be passed to \code{\link[rmarkdown]{render}}
#'
#' @export
#'
#' @examples
#' \dontrun{
#' ``` yaml
#' ---
#' ...
#' output: Rmdx::rmdx_docx
#' ---
#' ```
#' }
rmdx_docx = function(toc = TRUE, highlight = 'pygments', ...) {
  # locations of resource files in the package
  pkg_resource = function(...) {
    system.file(..., package = "Rmdx")
  }

  base_docx = pkg_resource("resources/docx/base.docx")

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

  officedown::rdocx_document(
    toc = toc,
    highlight = highlight,
    reference_docx = base_docx,
    ...
  )
}