slidy_presentation
Convert to a slidy presentation
Format for converting from R Markdown to a slidy presentation.
Usage
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",
mathjax = "default",
template = "default",
css = NULL,
includes = NULL,
keep_md = FALSE,
lib_dir = NULL,
md_extensions = NULL,
pandoc_args = NULL,
extra_dependencies = NULL,
...
)
Arguments
- number_sections
TRUE
to number section headings- incremental
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
- slide_level
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
Duration (in minutes) of the slide deck. This value is used to add a countdown timer to the slide footer.
- footer
Footer text (e.g. organization name and/or copyright)
- font_adjustment
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.
- fig_width
Default width (in inches) for figures
- fig_height
Default height (in inches) for figures
- fig_retina
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 beNULL
whenkeep_md
is specified (this is becausefig_retina
relies on outputting HTML directly into the markdown document).- fig_caption
TRUE
to render figures with captions- dev
Graphics device to use for figure output (defaults to pdf)
- df_print
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
, typicallyprint.data.frame
. The "kable" method uses theknitr::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 thedf_print
behavior entirely by setting the optionrmarkdown.df_print
toFALSE
.- self_contained
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).
- highlight
Syntax highlighting style. Supported styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", and "haddock". Pass
NULL
to prevent syntax highlighting.- mathjax
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.- 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 online documentation for details on creating custom templates.- css
One or more css files to include
- includes
Named list of additional content to include within the document (typically created using the
includes
function).- keep_md
Keep the markdown file generated by knitting.
- lib_dir
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.- 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
- extra_dependencies
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
Details
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.
Value
R Markdown output format to pass to render
Examples
# NOT RUN {
library(rmarkdown)
# simple invocation
render("pres.Rmd", slidy_presentation())
# specify an option for incremental rendering
render("pres.Rmd", slidy_presentation(incremental = TRUE))
# }