1% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/beamer_presentation.R
3\name{beamer_presentation}
4\alias{beamer_presentation}
5\title{Convert to a Beamer presentation}
6\usage{
7beamer_presentation(toc = FALSE, slide_level = NULL, incremental = FALSE,
8  fig_width = 10, fig_height = 7, fig_crop = TRUE, fig_caption = TRUE,
9  dev = "pdf", df_print = "default", theme = "default",
10  colortheme = "default", fonttheme = "default", highlight = "default",
11  template = "default", keep_tex = FALSE, latex_engine = "pdflatex",
12  citation_package = c("none", "natbib", "biblatex"), self_contained = TRUE,
13  includes = NULL, md_extensions = NULL, pandoc_args = NULL)
14}
15\arguments{
16\item{toc}{\code{TRUE} to include a table of contents in the output (only
17level 1 headers will be included in the table of contents).}
18
19\item{slide_level}{The heading level which defines individual slides. By
20default this is the highest header level in the hierarchy that is followed
21immediately by content, and not another header, somewhere in the document.
22This default can be overridden by specifying an explicit
23\code{slide_level}.}
24
25\item{incremental}{\code{TRUE} to render slide bullets incrementally. Note
26that if you want to reverse the default incremental behavior for an
27individual bullet you can precede it with \code{>}. For example:
28\emph{\code{> - Bullet Text}}}
29
30\item{fig_width}{Default width (in inches) for figures}
31
32\item{fig_height}{Default width (in inches) for figures}
33
34\item{fig_crop}{\code{TRUE} to automatically apply the \code{pdfcrop} utility
35(if available) to pdf figures}
36
37\item{fig_caption}{\code{TRUE} to render figures with captions}
38
39\item{dev}{Graphics device to use for figure output (defaults to pdf)}
40
41\item{df_print}{Method to be used for printing data frames. Valid values
42include "default", "kable", "tibble", and "paged". The "default" method uses
43\code{print.data.frame}. The "kable" method uses the
44\code{\link[knitr:kable]{knitr::kable}} function. The "tibble" method uses
45the \pkg{tibble} package to print a summary of the data frame. The "paged"
46method creates a paginated HTML table (note that this method is only valid
47for formats that produce HTML). In addition
48to the named methods you can also pass an arbitrary function to be used
49for printing data frames. You can disable the df_print behavior entirely
50by setting the option \code{rmarkdown.df_print} to \code{FALSE}.}
51
52\item{theme}{Beamer theme (e.g. "AnnArbor").}
53
54\item{colortheme}{Beamer color theme (e.g. "dolphin").}
55
56\item{fonttheme}{Beamer font theme (e.g. "structurebold").}
57
58\item{highlight}{Syntax highlighting style. Supported styles include
59"default", "tango", "pygments", "kate", "monochrome", "espresso",
60"zenburn", and "haddock". Pass \code{NULL} to prevent syntax highlighting.}
61
62\item{template}{Pandoc template to use for rendering. Pass "default" to use
63the rmarkdown package default template; pass \code{NULL} to use pandoc's
64built-in template; pass a path to use a custom template that you've
65created.  See the documentation on
66\href{http://pandoc.org/README.html}{pandoc online documentation}
67for details on creating custom templates.}
68
69\item{keep_tex}{Keep the intermediate tex file used in the conversion to PDF}
70
71\item{latex_engine}{LaTeX engine for producing PDF output. Options are
72"pdflatex", "lualatex", and "xelatex".}
73
74\item{citation_package}{The LaTeX package to process citations, \code{natbib}
75or \code{biblatex}. Use \code{none} if neither package is to be used.}
76
77\item{self_contained}{Whether to generate a full LaTeX document (\code{TRUE})
78or just the body of a LaTeX document (\code{FALSE}). Note the LaTeX
79document is an intermediate file unless \code{keep_tex = TRUE}.}
80
81\item{includes}{Named list of additional content to include within the
82document (typically created using the \code{\link{includes}} function).}
83
84\item{md_extensions}{Markdown extensions to be added or removed from the
85default definition or R Markdown. See the \code{\link{rmarkdown_format}} for
86additional details.}
87
88\item{pandoc_args}{Additional command line options to pass to pandoc}
89}
90\value{
91R Markdown output format to pass to \code{\link{render}}
92}
93\description{
94Format for converting from R Markdown to a Beamer presentation.
95}
96\details{
97See the
98\href{http://rmarkdown.rstudio.com/beamer_presentation_format.html}{online
99documentation} for additional details on using the \code{beamer_presentation}
100format.
101
102Creating Beamer output from R Markdown requires that LaTeX be installed.
103
104R Markdown documents can have optional metadata that is used to generate a
105document header that includes the title, author, and date. For more details
106see the documentation on R Markdown \link[=rmd_metadata]{metadata}.
107
108R Markdown documents also support citations. You can find more information on
109the markdown syntax for citations in the
110\href{http://rmarkdown.rstudio.com/authoring_bibliographies_and_citations.html}{Bibliographies
111and Citations} article in the online documentation.
112}
113\examples{
114\dontrun{
115
116library(rmarkdown)
117
118# simple invocation
119render("pres.Rmd", beamer_presentation())
120
121# specify an option for incremental rendering
122render("pres.Rmd", beamer_presentation(incremental = TRUE))
123}
124
125}
126