fao_slides: Convert to a Beamer presentation

Description Usage Arguments Details Value Examples

View source: R/fao_slides.R

Description

Format for converting from R Markdown to a Beamer presentation.

Usage

1
2
3
4
5
6
fao_slides(toc = FALSE, slide_level = NULL, incremental = FALSE,
  fig_width = 10, fig_height = 7, fig_crop = TRUE, fig_caption = FALSE,
  dev = "pdf", theme = "default", colortheme = "default",
  fonttheme = "default", 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 (only level 1 headers will be included in the table of contents).

slide_level

The heading level which defines indvidual slides. By default this is the highest header level in the hierarchy that is followed immediately by content, and not another header, somewhere in the document. This default can be overridden by specifying an explicit slide.level.

incremental

TRUE to render slide bullets incrementally. Note that if you want to reverse the default incremental behavior for an individual bullet you can preceded it with >. For example: > - Bullet Text

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)

theme

Beamer theme (e.g. "AnnArbor").

colortheme

Beamer color theme (e.g. "dolphin").

fonttheme

Beamer font theme (e.g. "structurebold").

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 pandoc templates for more details.

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 online documentation for additional details on using the beamer_presentation format.

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

For more information on markdown syntax for presentations see producing slide shows with pandoc.

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 Bibliographies and Citations article in the online documentation.

Value

R Markdown output format to pass to render

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 

library(rmarkdown)

# simple invocation
render("pres.Rmd", beamer_presentation())

# specify an option for incremental rendering
render("pres.Rmd", beamer_presentation(incremental = TRUE))

## End(Not run)

UNFAOstatistics/faodoc documentation built on June 3, 2017, 6:42 a.m.