View source: R/tutorial-format.R
Long-form tutorial which includes narrative, figures, videos, exercises, and questions.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | tutorial(
fig_width = 6.5,
fig_height = 4,
fig_retina = 2,
fig_caption = TRUE,
progressive = FALSE,
allow_skip = FALSE,
dev = "png",
df_print = "paged",
smart = TRUE,
theme = "rstudio",
highlight = "textmate",
ace_theme = "textmate",
mathjax = "default",
extra_dependencies = NULL,
css = NULL,
includes = NULL,
md_extensions = NULL,
pandoc_args = NULL,
...
)
|
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 |
fig_caption |
|
progressive |
Display sub-topics progressively (i.e. wait until previous topics are either completed or skipped before displaying subsequent topics). |
allow_skip |
Allow users to skip sub-topics (especially useful when
|
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 |
smart |
Produce typographically correct output, converting straight
quotes to curly quotes, |
theme |
Visual theme ("rstudio", default", "cerulean", "journal", "flatly", "readable", "spacelab", "united", "cosmo", "lumen", "paper", "sandstone", "simplex", or "yeti"). |
highlight |
Syntax highlighting style. Supported styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", "haddock", and "textmate". Pass ‘NULL’ to prevent syntax highlighting. Note, this value only pertains to standard rmarkdown code, not the Ace editor highlighting. |
ace_theme |
Ace theme supplied to the ace code editor for all exercises.
See |
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
|
extra_dependencies |
Additional function arguments to pass to the
base R Markdown HTML output formatter |
css |
One or more css files to include |
includes |
Named list of additional content to include within the
document (typically created using the |
md_extensions |
Markdown extensions to be added or removed from the
default definition or R Markdown. See the |
pandoc_args |
Additional command line options to pass to pandoc |
... |
Forward parameters to html_document |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.