html_document: Use Bioconductor style to format R Markdown HTML output

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/html_document.R

Description

Format for converting from R Markdown to an Bioconductor HTML document.

Usage

1
2
3
html_document(toc = TRUE, number_sections = TRUE, fig_width = NA,
  fig_height = NA, self_contained = TRUE, css = NULL,
  pandoc_args = NULL, ..., titlecaps = TRUE)

Arguments

toc

logical(1), TRUE to include a table of contents in the output

number_sections

logical(1), TRUE to number section headings

fig_width

numeric(1), default width (in inches) for figures

fig_height

numeric(1), default width (in inches) for figures

self_contained

numeric(1), TRUE to 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).

css

character, one or more css files to include

pandoc_args

character, additional command line options to pass to pandoc

...

Additional arguments passed to html_document

titlecaps

logical(1), TRUE to use the emphasize the first sentence in figure and table captions as title

Details

BiocStyle::html_document format extends the html_document format. See the online documentation and the package vignette "Authoring R Markdown Vignettes" for additional details on using the format,

Value

R Markdown output format to pass to render

Author(s)

Andrzej Oleś <[email protected]>, 2014-2017

See Also

pdf_document, md_document

Examples

1
2
3
4
5
6
7
8
9
## Not run: 

# simple invocation
render("input.Rmd", BiocStyle::html_document())

# specify options
render("input.Rmd", BiocStyle::html_document(toc = FALSE))

## End(Not run)

Bioconductor/BiocStyle documentation built on Feb. 6, 2020, 11:22 p.m.