Format for converting from R Markdown to a slidy presentation.
slidy_presentation(
number_sections = FALSE,
incremental = FALSE,
slide_level = NULL,
duration = NULL,
footer = NULL,
font_adjustment = 0,
fig_width = 8,
fig_height = 6,
fig_retina = 2,
fig_caption = TRUE,
dev = "png",
df_print = "default",
self_contained = TRUE,
highlight = "default",
math_method = "default",
mathjax = "default",
template = "default",
css = NULL,
includes = NULL,
keep_md = FALSE,
lib_dir = NULL,
md_extensions = NULL,
pandoc_args = NULL,
extra_dependencies = NULL,
...
)R Markdown output format to pass to render
TRUE to number section headings
TRUE to render slide bullets incrementally. Note
that if you want to reverse the default incremental behavior for an
individual bullet you can precede it with >. For example:
> - Bullet Text. See more in
Pandoc's Manual
The heading level which defines individual 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.
Duration (in minutes) of the slide deck. This value is used to add a countdown timer to the slide footer.
Footer text (e.g. organization name and/or copyright)
Increase or decrease the default font size (e.g. -1 or +1). You can also manually adjust the font size during the presentation using the 'S' (smaller) and 'B' (bigger) keys.
Default width (in inches) for figures
Default height (in inches) for figures
Scaling to perform for retina displays (defaults to 2, which
currently works for all widely used retina displays). Set to NULL to
prevent retina scaling. Note that this will always be NULL when
keep_md is specified (this is because fig_retina relies on
outputting HTML directly into the markdown document).
TRUE to render figures with captions
Graphics device to use for figure output (defaults to pdf)
Method to be used for printing data frames. Valid values
include "default", "kable", "tibble", and "paged". The "default" method
uses a corresponding S3 method of print, typically
print.data.frame. The "kable" method uses the
knitr::kable function. The "tibble" method uses
the tibble package to print a summary of the data frame. The "paged"
method creates a paginated HTML table (note that this method is only valid
for formats that produce HTML). In addition to the named methods you can
also pass an arbitrary function to be used for printing data frames. You
can disable the df_print behavior entirely by setting the option
rmarkdown.df_print to FALSE. See
Data
frame printing section in bookdown book for examples.
Produce a standalone HTML file with no external dependencies, using data: URIs to incorporate the contents of linked scripts, stylesheets, images, and videos. Note that even for self contained documents MathJax is still loaded externally (this is necessary because of its size).
Syntax highlighting style passed to Pandoc.
Supported built-in styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", "haddock", and "breezedark".
Two custom styles are also included, "arrow", an accessible color scheme, and "rstudio", which mimics the default IDE theme. Alternatively, supply a path to a .theme file to use a custom Pandoc style. Note that custom theme requires Pandoc 2.0+.
Pass NULL to prevent syntax highlighting.
Math rendering engine to use. This will define the math method to use with Pandoc.
It can be a string for the engine, one of "mathjax", "mathml", "webtex", "katex", "gladtex", or "r-katex"
or "default" for mathjax.
It can be a list of
engine: one of
"mathjax", "mathml", "webtex", "katex", or "gladtex".
url: A specific url to use with mathjax, katex or webtex.
Note that for engine = "mathjax", url = "local" will use a local version of MathJax (which is
copied into the output directory).
For example,
output:
html_document:
math_method:
engine: katex
url: https://cdn.jsdelivr.net/npm/katex@0.11.1/dist
See Pandoc's Manual about Math in HTML for the details about Pandoc supported methods.
Using math_method = "r-katex" will opt-in server side rendering using
KaTeX thanks to katex R package. This is
useful compared to math_method = "katex" to have no JS dependency, only a
CSS dependency for styling equation.
Include mathjax. The "default" option uses an https URL from a
MathJax CDN. The "local" option uses a local version of MathJax (which is
copied into the output directory). You can pass an alternate URL or pass
NULL to exclude MathJax entirely.
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 online documentation for
details on creating custom templates.
One or more css files to include.
Named list of additional content to include within the
document (typically created using the includes function).
Keep the markdown file generated by knitting.
Directory to copy dependent HTML libraries (e.g. jquery,
bootstrap, etc.) into. By default this will be the name of the document with
_files appended to it.
Markdown extensions to be added or removed from the
default definition of R Markdown. See the rmarkdown_format for
additional details.
Additional command line options to pass to pandoc
A LaTeX dependency latex_dependency(), a
list of LaTeX dependencies, a character vector of LaTeX package names (e.g.
c("framed", "hyperref")), or a named list of LaTeX package options
with the names being package names (e.g. list(hyperef =
c("unicode=true", "breaklinks=true"), lmodern = NULL)). It can be used to
add custom LaTeX packages to the .tex header.
Additional function arguments to pass to the base R Markdown HTML
output formatter html_document_base
See the online
documentation for additional details on using the slidy_presentation
format.
For more information on markdown syntax for presentations see the pandoc online documentation.
if (FALSE) {
library(rmarkdown)
# simple invocation
render("pres.Rmd", slidy_presentation())
# specify an option for incremental rendering
render("pres.Rmd", slidy_presentation(incremental = TRUE))
}
Run the code above in your browser using DataLab