ioslides_presentation: ioslides_presentation

In mcanouil/mctemplates: Mickaël Canouil's Rmarkdown & Rstudio templates

Description

Format for converting from R Markdown to an ioslides presentation.

Usage

ioslides_presentation(
  logo = NULL,
  slide_level = 2,
  incremental = FALSE,
  fig_width = 5.94,
  fig_height = 3.3,
  fig_retina = 2,
  fig_caption = TRUE,
  dev = "ragg_png",
  df_print = "default",
  smart = TRUE,
  self_contained = TRUE,
  widescreen = TRUE,
  smaller = FALSE,
  transition = "default",
  mathjax = "default",
  analytics = NULL,
  template = NULL,
  css = NULL,
  includes = NULL,
  keep_md = FALSE,
  lib_dir = NULL,
  md_extensions = NULL,
  pandoc_args = NULL,
  extra_dependencies = NULL,
  csl = NULL,
  ...
)

Arguments

logo	Path to file that includes a logo for use in the presentation (should be square and at least 128x128).
slide_level	Header level to consider as slide separator (Defaults to header 2).
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 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 be NULL when keep_md is specified (this is because fig_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 png)
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, 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.
smart	Produce typographically correct output, converting straight quotes to curly quotes, --- to em-dashes, -- to en-dashes, and ... to ellipses.
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).
widescreen	Display presentation with wider dimensions.
smaller	Use smaller text on all slides. You can also enable this for individual slides by adding the .smaller attribute to the slide header (see Presentation Size below for details).
transition	Speed of slide transitions. This can be "default", "slower", "faster", or a numeric value with a number of seconds (e.g. 0.5).
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.
analytics	A Google analytics property ID.
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. Note that if you don't use the "default" template then some features of html_document won't be available (see the Templates section below for more details).
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	Additional function arguments to pass to the base R Markdown HTML output formatter html_document_base
csl	bibliography style as a csl file.
...	Arguments to be passed to a specific output format function rmarkdown::ioslides_presentation

Value

R Markdown output format to pass to render

mcanouil/mctemplates documentation built on Feb. 25, 2021, 5:17 p.m.