R/pdf_book.R

In fnaufel/fnaufelRmd: fnaufel's RMarkdown templates and formats

#' Custom PDF template for books
#'
#' Loads additional style and configs
#'
#' @title pdf_book
#'
#' @param copy_supporting_files If TRUE, copy supporting files (.csl etc.) to document dir before rendering
#' @param toc see [bookdown::pdf_book]
#' @param number_sections see [bookdown::pdf_book]
#' @param fig_caption see [bookdown::pdf_book]
#' @param pandoc_args see [bookdown::pdf_book]
#' @param base_format see [bookdown::pdf_book]
#' @param toc_unnumbered see [bookdown::pdf_book]
#' @param toc_appendix see [bookdown::pdf_book]
#' @param toc_bib see [bookdown::pdf_book]
#' @param quote_footer see [bookdown::pdf_book]
#' @param highlight_bw see [bookdown::pdf_book]
#' @param df_print see [bookdown::pdf_book]
#' @param keep_tex see [bookdown::pdf_book]
#' @param latex_engine see [bookdown::pdf_book]
#' @param citation_package see [bookdown::pdf_book]
#' @param includes see [bookdown::pdf_book]
#' @param md_extensions see [bookdown::pdf_book]
#' @param template see [bookdown::pdf_book]
#' @param ... see [bookdown::pdf_book]
#'
#' @return see [bookdown::pdf_book]
#'
#' @importFrom rmarkdown pdf_document includes
#' @importFrom bookdown pdf_book
#'
#' @author fnaufel
#'
#' @export
#'
pdf_book <- function(
  copy_supporting_files = TRUE,
  toc = TRUE,
  number_sections = TRUE,
  fig_caption = TRUE,
  pandoc_args = c(
    '--variable=link-as-notes',
    paste0(
      '--variable=',
      'resources:',
      system.file('rmarkdown/resources', package = 'fnaufelRmd')
    ),
    '--variable=subparagraph',
    paste0(
      '--filter=',
      system.file(
        "rmarkdown/resources/pandoc_filters/dollar.py3",
        package = "fnaufelRmd"
      )
    ),
    paste0(
      '--filter=',
      system.file(
        "rmarkdown/resources/pandoc_filters/hl.py3",
        package = "fnaufelRmd"
      )
    )
  ),
  base_format = rmarkdown::pdf_document,
  toc_unnumbered = TRUE,
  toc_appendix = TRUE,
  toc_bib = TRUE,
  quote_footer = NULL,
  highlight_bw = FALSE,
  df_print = 'tibble',
  keep_tex = TRUE,
  latex_engine = 'xelatex',
  citation_package = 'default',
  includes = NULL,
  md_extensions = '+fenced_divs+bracketed_spans',
  template = system.file(
    'rmarkdown/resources/tex/bd-format.latex',
    package = 'fnaufelRmd'
  ),
  ...
) {

  if (copy_supporting_files) {
    # Destination dir for supporting files (PDF)
    target_dir <- normalizePath('pdf_files')
    if (!dir.exists(target_dir))
      dir.create(target_dir)

    supporting <- system.file(
      c(
        'rmarkdown/resources/pdf_files/abnt.csl',
        'rmarkdown/resources/pdf_files/chicago-author-date.csl'
      ),
      package = 'fnaufelRmd'
    )

    file.copy(
      from = supporting,
      to = target_dir,
      overwrite = TRUE,
      recursive = TRUE,
      copy.date = TRUE
    )

  }

  # includes
  full_incl <- rmarkdown::includes(
    in_header = system.file(
      "rmarkdown/resources/tex/bd-preamble.tex",
      package = "fnaufelRmd"
    )
  )

  if (!is.null(includes)) {
    full_incl <- merge_named_lists(full_incl, includes)
  }

  # call the base function
  bookdown::pdf_book(
    toc = toc,
    number_sections = number_sections,
    fig_caption = fig_caption,
    pandoc_args = pandoc_args,
    base_format = base_format,
    toc_unnumbered = toc_unnumbered,
    toc_appendix = toc_appendix,
    toc_bib = toc_bib,
    quote_footer = quote_footer,
    highlight_bw = highlight_bw,
    df_print = df_print,
    keep_tex = keep_tex,
    latex_engine = latex_engine,
    citation_package = citation_package,
    includes = full_incl,
    md_extensions = md_extensions,
    template = template,
    ...
  )

}