render_appendix: Render Appendix (defunct)

View source: R/deprecated_defunct.R

render_appendixR Documentation

Render Appendix (defunct)

Description

This function renders an R Markdown document without YAML header to a TeX fragment inside an appendix environment, or to a markdown fragment (for Word output). This function has been defunct. Please use the appendix syntax provided by bookdown (see the bookdown manual).

Usage

render_appendix(
  x,
  bibliography = rmarkdown::metadata$bibliography,
  csl = rmarkdown::metadata$csl,
  quiet = TRUE,
  ...
)

Arguments

x

Character. Path to R Markdown file.

bibliography

Character. Paths to relevant bibliography file(s).

csl

Character. Path to CSL file to use. Defaults to APA-style.

quiet

Logical. Suppresses pandoc command line output; see render. If FALSE output will be included in the document.

...

Arguments passed on to rmarkdown::pandoc_convert

input

Character vector containing paths to input files (files must be UTF-8 encoded)

to

Format to convert to (if not specified, you must specify output)

from

Format to convert from (if not specified then the format is determined based on the file extension of input).

output

Output file (if not specified then determined based on format being converted to).

citeproc

TRUE to run the pandoc-citeproc filter (for processing citations) as part of the conversion.

options

Character vector of command line options to pass to pandoc.

verbose

TRUE to show the pandoc command line which was executed

wd

Working directory in which code will be executed. If not supplied, defaults to the common base directory of input.

Details

This function is only exported for backwards compatibility. It is now recommended not to call render_appendix() directly. Instead, to add appendices to your manuscript, add the R Markdown file to the YAML front matter by using appendix: "appendix.Rmd".

Default chunk options and hooks are set to those used in the R Markdown document from which render_appendix is called; otherwise defaults of md_document are used.

By default, x is converted to a TeX file, which can be included in an R Markdown document as include:

  output:
    pdf_document:
      include:
        after_body: appendix.tex
  

If render_appendix is called form an R Markdown document with a target document type other than a PDF file, a markdown fragment is included.

Value

Returns NULL invisibly.


papaja documentation built on Oct. 30, 2024, 9:09 a.m.