1% Generated by roxygen2: do not edit by hand 2% Please edit documentation in R/html_notebook.R 3\name{html_notebook} 4\alias{html_notebook} 5\title{Convert to an HTML notebook} 6\usage{ 7html_notebook(toc = FALSE, toc_depth = 3, toc_float = FALSE, 8 number_sections = FALSE, fig_width = 7, fig_height = 5, 9 fig_retina = 2, fig_caption = TRUE, code_folding = "show", 10 smart = TRUE, theme = "default", highlight = "textmate", 11 mathjax = "default", extra_dependencies = NULL, css = NULL, 12 includes = NULL, md_extensions = NULL, pandoc_args = NULL, 13 output_source = NULL, self_contained = TRUE, ...) 14} 15\arguments{ 16\item{toc}{\code{TRUE} to include a table of contents in the output} 17 18\item{toc_depth}{Depth of headers to include in table of contents} 19 20\item{toc_float}{\code{TRUE} to float the table of contents to the left of the 21main document content. Rather than \code{TRUE} you may also pass a list of 22options that control the behavior of the floating table of contents. See the 23\emph{Floating Table of Contents} section below for details.} 24 25\item{number_sections}{\code{TRUE} to number section headings} 26 27\item{fig_width}{Default width (in inches) for figures} 28 29\item{fig_height}{Default width (in inches) for figures} 30 31\item{fig_retina}{Scaling to perform for retina displays (defaults to 2, which 32currently works for all widely used retina displays). Set to \code{NULL} to 33prevent retina scaling. Note that this will always be \code{NULL} when 34\code{keep_md} is specified (this is because \code{fig_retina} relies on 35outputting HTML directly into the markdown document).} 36 37\item{fig_caption}{\code{TRUE} to render figures with captions} 38 39\item{code_folding}{Enable document readers to toggle the display of R code 40chunks. Specify \code{"none"} to display all code chunks (assuming 41they were knit with \code{echo = TRUE}). Specify \code{"hide"} to hide all R 42code chunks by default (users can show hidden code chunks either 43individually or document-wide). Specify \code{"show"} to show all R code 44chunks by default.} 45 46\item{smart}{Produce typographically correct output, converting straight 47quotes to curly quotes, --- to em-dashes, -- to en-dashes, and ... to 48ellipses.} 49 50\item{theme}{Visual theme ("default", "cerulean", "journal", "flatly", 51"readable", "spacelab", "united", "cosmo", "lumen", "paper", "sandstone", 52"simplex", or "yeti"). Pass \code{NULL} for no theme (in this case you can 53use the \code{css} parameter to add your own styles).} 54 55\item{highlight}{Syntax highlighting style. Supported styles include 56"default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", 57"haddock", and "textmate". Pass \code{NULL} to prevent syntax highlighting.} 58 59\item{mathjax}{Include mathjax. The "default" option uses an https URL from a 60MathJax CDN. The "local" option uses a local version of MathJax (which is 61copied into the output directory). You can pass an alternate URL or pass 62\code{NULL} to exclude MathJax entirely.} 63 64\item{extra_dependencies}{Additional function arguments to pass to the 65base R Markdown HTML output formatter \code{\link{html_document_base}}} 66 67\item{css}{One or more css files to include} 68 69\item{includes}{Named list of additional content to include within the 70document (typically created using the \code{\link{includes}} function).} 71 72\item{md_extensions}{Markdown extensions to be added or removed from the 73default definition or R Markdown. See the \code{\link{rmarkdown_format}} for 74additional details.} 75 76\item{pandoc_args}{Additional command line options to pass to pandoc} 77 78\item{output_source}{Define an output source for \R chunks (ie, 79outputs to use instead of those produced by evaluating the 80underlying \R code). See \code{\link{html_notebook_output}} for 81more details.} 82 83\item{self_contained}{Produce a standalone HTML file with no external 84dependencies. Defaults to \code{TRUE}. In notebooks, setting this to 85\code{FALSE} is not recommended, since the setting does not apply to 86embedded notebook output such as plots and HTML widgets.} 87 88\item{...}{Additional function arguments to pass to the 89base R Markdown HTML output formatter \code{\link{html_document_base}}} 90} 91\description{ 92Format for converting from R Markdown to an HTML notebook. 93} 94\details{ 95For more details on the HTML file format produced by 96 \code{html_notebook}, see \href{http://rmarkdown.rstudio.com/r_notebook_format.html}{http://rmarkdown.rstudio.com/r_notebook_format.html}. 97} 98