R Graphical Manual

Browse All

Last data update: 2014.03.03

R: Enable BiocStyle macros and a hyperlinked TOC in markdown...

md_document

R Documentation

Enable BiocStyle macros and a hyperlinked TOC in markdown output

Description

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

Usage

md_document(toc = TRUE, toc_depth = 3, ...)

Arguments

`toc`	`TRUE` to include a table of contents in the output
`toc_depth`	Depth of headers to include in table of contents
`...`	Additional function arguments to pass to the base R Markdown `md_document` output formatter

Details

The BiocStyle::md_document format extends the md_document format by a hyperlinked TOC. It also loads the BiocStyle package namespace to enable the use of helper functions, such as Biocpkg.

Value

R Markdown output format to pass to render

Author(s)

Andrzej Ole<c3><85><c2><9b> <andrzej.oles@embl.de>, 2015

Examples

## Not run: 

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


## End(Not run)