rmarkdown (version 0.5.1)

html_document: Convert to an HTML document

Description

Format for converting from R Markdown to an HTML document.

Usage

html_document(toc = FALSE, toc_depth = 3, number_sections = FALSE,
  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, pandoc_args = NULL, ...)

Arguments

toc

TRUE to include a table of contents in the output

toc_depth

Depth of headers to include in table of contents

number_sections

TRUE to number section headings

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 is FALSE, which currently works for all widely used retina displays). Set to NULL to prevent retina scaling. Note that this will always be

fig_caption

TRUE to render figures with captions

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 necessar

theme

Visual theme ("default", "cerulean", "journal", "flatly", "readable", "spacelab", "united", or "cosmo"). Pass NULL for no theme (in this case you can use the css parameter to add your own styles).

highlight

Syntax highlighting style. Supported styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", "haddock", and "textmate". Pass NULL to prevent syntax highlighting.

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 NULL to exclude MathJ

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

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.

pandoc_args

Additional command line options to pass to pandoc

...

Additional function arguments to pass to the base R Markdown HTML output formatter

Value

• R Markdown output format to pass to render

Templates

You can provide a custom HTML template to be used for rendering. The syntax for templates is described in the documentation on http://johnmacfarlane.net/pandoc/demo/example9/templates.html{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:

• Thethemeparameter does not work (you can still provide styles using thecssparameter).

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).

code

includes

Details

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 within the pandoc documentation on http://johnmacfarlane.net/pandoc/demo/example19/Citations.html{citations} and http://johnmacfarlane.net/pandoc/demo/example19/Footnotes.html{footnotes}.

Examples

library(rmarkdown)

render("input.Rmd", html_document())

render("input.Rmd", html_document(toc = TRUE))