BiocStyle (version 2.0.2)

md_document: 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

Value

R Markdown output format to pass to render

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.

See Also

html_document, pdf_document

Examples

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