pdf_document

0th

Percentile

Convert to a PDF document

Format for converting from R Markdown to a PDF document.

Usage
pdf_document(toc = FALSE, toc_depth = 2, number_sections = FALSE,
  fig_width = 6.5, fig_height = 4.5, fig_crop = TRUE,
  fig_caption = FALSE, dev = "pdf", highlight = "default",
  template = "default", keep_tex = FALSE, latex_engine = "pdflatex",
  includes = NULL, md_extensions = NULL, pandoc_args = NULL)
Arguments
toc
TRUE to include a table of contents in the output
toc_depth
Depth of headers to include in table of contents
number_sections
TRUE to number section headings
fig_width
Default width (in inches) for figures
fig_height
Default width (in inches) for figures
fig_crop
TRUE to automatically apply the pdfcrop utility (if available) to pdf figures
fig_caption
TRUE to render figures with captions
dev
Graphics device to use for figure output (defaults to pdf)
highlight
Syntax highlighting style. Supported styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", and "haddock". Pass NULL to prevent syntax highlighting.
template
Pandoc template to use for rendering. Pass "default" to use the rmarkdown package default template; pass NULL to use pandoc's built-in template; pass a path to use a custom template that you've created. See the documentation on
keep_tex
Keep the intermediate tex file used in the conversion to PDF
latex_engine
LaTeX engine for producing PDF output. Options are "pdflatex", "lualatex", and "xelatex".
includes
Named list of additional content to include within the document (typically created using the includes function).
md_extensions
Markdown extensions to be added or removed from the default definition or R Markdown. See the rmarkdown_format for additional details.
pandoc_args
Additional command line options to pass to pandoc
Details

See the http://rmarkdown.rstudio.com/pdf_document_format.html{online documentation} for additional details on using the pdf_document format.

Creating PDF output from R Markdown requires that LaTeX be installed.

R Markdown documents can have optional metadata that is used to generate a document header that includes the title, author, and date. For more details see the documentation on R Markdown metadata.

R Markdown documents also support citations. You can find more information on the markdown syntax for citations in the http://rmarkdown.rstudio.com/authoring_bibliographies_and_citations.html{Bibliographies and Citations} article in the online documentation.

Many aspects of the LaTeX template used to create PDF documents can be customized using metadata. For example:

l{ --- title: "Crop Analysis Q3 2013" fontsize: 11pt geometry: margin=1in --- }

Available metadata variables include:

[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

Value

  • R Markdown output format to pass to render

Aliases
  • pdf_document
Examples
library(rmarkdown)

# simple invocation
render("input.Rmd", pdf_document())

# specify an option for latex engine
render("input.Rmd", pdf_document(latex_engine = "lualatex"))

# add a table of contents and pass an option to pandoc
render("input.Rmd", pdf_document(toc = TRUE, "--listings"))
Documentation reproduced from package rmarkdown, version 0.6.1, License: GPL-3

Community examples

Looks like there are no examples yet.