pdf_document: Use Bioconductor style to format R Markdown PDF output

In Bioconductor/BiocStyle: Standard styles for vignettes and other Bioconductor documents

Use Bioconductor style to format R Markdown PDF output

Description

This function sets the Bioconductor style in PDF documents rendered using R Markdown v2.

Usage

pdf_document(toc = TRUE, number_sections = TRUE, fig_width = NA,
  fig_height = NA, includes = NULL, ..., titlecaps = TRUE,
  toc_newpage = FALSE, use_unsrturl = TRUE, relative_path = FALSE)

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
includes	Named list of additional content to include within the document (typically created using the includes function).
...	Additional arguments passed to pdf_document.
titlecaps	logical(1), TRUE to use the emphasize the first sentence in figure and table captions as title
toc_newpage	logical(1), TRUE to start the table of contents on a new page.
use_unsrturl	logical(1), indicating that the ‘unsrturl’ style will be used (\bibliographystyle command not required).
relative_path	logical(1), copy supporting LaTeX files and use relative paths rather than absolute paths to system files.

Value

R Markdown output format to pass to render.

Author(s)

Andrzej Oleś <[e-mail]>, 2014-2017

See Also

html_document, md_document

Examples

## Not run: 

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

# specify an option for latex engine
render("input.Rmd", BiocStyle::pdf_document(toc = FALSE))

## End(Not run)

Bioconductor/BiocStyle documentation built on Oct. 31, 2024, 8:02 a.m.