Learn R Programming

lazyWeave (version 3.0.0)

setHtmlOptions: lazyWeave HTML Report Options

Description

Sets or changes options for report counters, font, font size, and footnotes. The counter options apply to HTML and Markdown documents, and the font options only apply to HTML.

Usage

setHtmlOptions(table = NULL, figure = NULL, footnote = NULL,
  chapter = NULL, section = NULL, subsection = NULL,
  subsubsection = NULL, font.family = NULL, font = NULL,
  font.size = NULL)

Arguments

table
Sets the HTML table counter
figure
Sets the HTML figure counter
footnote
Sets the HTML footnote counter
chapter
Sets the HTML chapter counter
section
Sets the HTML section counter
subsection
Sets the HTML section counter
subsubsection
Sets the HTML subsubsection counter
font.family
Sets the HTML font family
font
Sets the HTML font
font.size
Sets the HTML font size

Details

For all arguments, a value of NULL results in no action.

The HTML counters are used to maintain a somewhat consistent appearance between HTML and LaTeX reports. Since HTML doesn't have counters, a series of variables is inserted into the Global Environment. These are hidden from view and are incremented automatically by lazyWeave function. Manipulating these variables directly is strongly discouraged. They can all be managed by lazy.counter.

setHtmlOptions is a convenience function that can change all of the global variables simultaneously (as opposed to repeated calls to lazy.counter). However, this is the recommended way to change font family, font, and font size.

To change the report format, use the code options(lazyReportFormat = "latex"), options(lazyReportFormat = "html") or, options(lazyReportFormat = "markdown")