Description Usage Arguments Details Value Templates Examples
View source: R/remark_presentation_format.R
Format for converting from R Markdown to an HTML document.
1 2 3 4 5 6 | remark_presentation_format(fig_width = 7, fig_height = 5, fig_retina = if
(!fig_caption) 2, fig_caption = FALSE, dev = "png", smart = TRUE,
self_contained = TRUE, theme = "default", highlight = "default",
mathjax = "default", template = "default", css = NULL,
includes = NULL, keep_md = FALSE, lib_dir = NULL,
md_extensions = NULL, pandoc_args = NULL, ...)
|
fig_width |
Default width (in inches) for figures |
fig_height |
Default width (in inches) for figures |
fig_retina |
Scaling to perform for retina displays (defaults to 2 when
|
fig_caption |
|
dev |
Graphics device to use for figure output (defaults to png) |
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 it's size). |
theme |
Visual theme ("default", "cerulean", "journal", "flatly",
"readable", "spacelab", "united", or "cosmo"). Pass |
highlight |
Syntax highlighting style. Supported styles include
"default", "tango", "pygments", "kate", "monochrome", "espresso",
"zenburn", "haddock", and "textmate". Pass |
mathjax |
Include mathjax. The "default" option uses an https URL from
the official 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 |
template |
Pandoc template to use for rendering. Pass "default"
to use the rmarkdown package default template; pass |
css |
One or more css files to include |
includes |
Named list of additional content to include within the
document (typically created using the |
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 |
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 |
... |
Additional function arguments to pass to the base R Markdown HTML output formatter |
R Markdown documents can have optional metadata that is used to generate a document header that includes the title, author, and date. For more details see the documentation on R Markdown metadata.
R Markdown documents also support citations. You can find more information on the markdown syntax for citations in the Bibliographies and Citations article in the online documentation.
R Markdown output format to pass to render
You can provide a custom HTML template to be used for rendering. The syntax
for templates is described in the documentation on
pandoc
templates. You can also use the basic pandoc template by passing
template = NULL
.
Note however that if you choose not to use the "default" HTML template then several aspects of HTML document rendering will behave differently:
The theme
parameter does not work (you can still
provide styles using the css
parameter).
For the highlight
parameter, the default highlighting
style will resolve to "pygments" and the "textmate" highlighting
style is not available
MathJax will not work if self_contained
is TRUE
(these two options can't be used together in normal pandoc templates).
Due to the above restrictions, you might consider using the includes
parameter as an alternative to providing a fully custom template.
1 2 3 4 5 6 7 8 9 |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.