rmarkdown (version 0.9.5)

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, toc_float = FALSE,
  number_sections = FALSE, fig_width = 7, fig_height = 5,
  fig_retina = if (!fig_caption) 2, fig_caption = FALSE, dev = "png",
  code_folding = c("none", "show", "hide"), smart = TRUE,
  self_contained = TRUE, theme = "default", highlight = "default",
  mathjax = "default", template = "default", extra_dependencies = NULL,
  css = NULL, includes = NULL, keep_md = FALSE, lib_dir = NULL,
  md_extensions = 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

toc_float

TRUE to float the table of contents to the left of the main document content. Rather than TRUE you may also pass a list of options that control the behavior of the floating table of contents. See the Floating Table of Content

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)

code_folding

Enable document readers to toggle the display of R code chunks. Defaults to "none" which displays all code chunks (assuming they were knit with echo = TRUE). Specify "hide" to hide all R code chunks by default (users

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", "cosmo", "lumen", "paper", "sandstone", "simplex", or "yeti"). Pass NULL for no theme (in this case you can use the css parameter to add

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

extra_dependencies, ...

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

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

Value

• R Markdown output format to pass to render

Navigation Bars

If you have a set of html documents which you'd like to provide a common global navigation bar for, you can include a "_navbar.html" file within the same directory as your html document and it will automatically be included at the top of the document. For a simple example of including a navigation bar see .https://github.com/rstudio/rmarkdown-website/blob/master/_navbar.html{https://github.com/rstudio/rmarkdown-website/blob/master/_navbar.html} For additional documentation on creating Bootstrap navigation bars see http://getbootstrap.com/components/#navbar{http://getbootstrap.com/components/#navbar}.

Floating Table of Contents

You may specify a list of options for the toc_float parameter which control the behavior of the floating table of contents. Options include:

• collapsed(defaults toTRUE) controls whether the table of contents appers with only the top-level (H2) headers. When collapsed the table of contents is automatically expanded inline when necessary.

smooth_scroll (defaults to TRUE) controls whether page scrolls are animated when table of contents items are navigated to via mouse clicks.

Tabbed Sections

You can organize content using tabs by applying the .tabset class attribute to headers within a document. This will cause all sub-headers of the header with the .tabset attribute to appear within tabs rather than as standalone sections. For example:

## Quarterly Results {.tabset}

### By Product

### By Region

You can also specify two additional attributes to control the appearance and behavior of the tabs. The .tabset-fade attributes causes the tabs to fade in and out when switching. The .tabset-pills attribute causes the visual appearance of the tabs to be "pill" rather than traditional tabs. For example:

## Quarterly Results {.tabset .tabset-fade .tabset-pills}

Templates

You can provide a custom HTML template to be used for rendering. The syntax for templates is described in the http://pandoc.org/README.html{pandoc documentation}. 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 The toc_float parameter will not work. The code_folding parameter will not work. Tabbed sections (as described above) will not work. Navigation bars (as described above) will not work.MathJax will not work if self_contained is TRUE (these two options can't be used together in normal pandoc templates).

code

includes

Details

See the http://rmarkdown.rstudio.com/html_document_format.html{online documentation} for additional details on using the html_document format.

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 http://rmarkdown.rstudio.com/authoring_bibliographies_and_citations.html{Bibliographies and Citations} article in the online documentation.

Examples

library(rmarkdown)

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

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