multi_document: Writing Complex Scientific Reports in R

Description Usage Arguments

Description

An R Markdown document format for multi-part reports. The *Multi-part Report* template included in the package provides a detailed example of its use.

Usage

1
2
3
4
5
6
7
8
9
multi_document(theme = NULL, highlight = NULL, pandoc_args = NULL,
  fig_format = c("screen", "print"), fig_download = TRUE,
  tab_download = TRUE, fig_height = 8, fig_width = 8,
  figcap_prefix = "Figure", figcap_sep = ":",
  figcap_prefix_highlight = "**", thumbnail = TRUE,
  thumbnail_size = "col-md-6", tabcap_prefix = "Table", tabcap_sep = ":",
  tabcap_prefix_highlight = "**", dpi = 300, use_namespace = FALSE,
  template = system.file(package = "reportMD", "rmarkdown/rmd/default.html"),
  depends = NULL, ...)

Arguments

theme

Visual theme to use for styling of the html output

highlight

Visual style to use for Syntax highlighting

pandoc_args

Arguments to be passed to pandoc

fig_format

Default format(s) for figures

fig_download

Logical indicating whether a download link should be added to figure captions.

tab_download

Logical indicating whether a download link should be added to table captions.

fig_height

Default figure height in inches.

fig_width

Default figure width in inches.

figcap_prefix

Prefix to use for figure labels. Figure labels will consist of this prefix and an automatically generated number.

figcap_sep

Separator to use between figure label and caption.

figcap_prefix_highlight

Markdown to use for highlighting of figure label.

thumbnail

A logical indicating whether thumbnails should be included in the output document instead of the full figure.

thumbnail_size

The width of the thumbnails, specified as a bootstrap column class. The default produces thumbnails that are 50% of the text width. Use col-md-12 for full width thumbnails.

tabcap_prefix

Prefix to use for table labels. Table labels will consist of this prefix and an automatically generated number.

tabcap_sep

Separator to use between table label and caption.

tabcap_prefix_highlight

Markdown to use for highlighting of table label.

dpi

The resolution to use for figures.

use_namespace

Logical indicating whether variables loaded from dependencies should be encapsulated into their own namespace. If TRUE these variables are loaded into a separate environment for each depedency, rather than into the global environment.

template

Path to custom template

depends

List of dependencies.

...

Additional arguments are passed to rmarkdown::html_document


humburg/reportmd documentation built on May 17, 2019, 9:13 p.m.