html_report: html_report

In mcanouil/mctemplates: Mickaël Canouil's Rmarkdown & Rstudio templates

Description

These are simple wrappers of the output format functions like rmarkdown::html_document(), and they added the capability of numbering figures/tables/equations/theorems and cross-referencing them. See References for the syntax. Note you can also cross-reference sections by their ID's using the same syntax when sections are numbered. In case you want to enable cross reference in other formats, use markdown_document2 with base_format argument.

Usage

html_report(
  toc_depth = 3,
  fig_width = 6.3,
  fig_height = 4.7,
  number_sections = TRUE,
  self_contained = TRUE,
  mathjax = "default",
  df_print = "kable",
  code_download = TRUE,
  ...
)

Arguments

toc_depth	Depth of headers to include in table of contents
fig_width	Default width (in inches) for figures
fig_height	Default height (in inches) for figures
number_sections	TRUE to number section headings
self_contained	Produce a standalone HTML file with no external dependencies, using data: URIs to incorporate the contents of linked scripts, stylesheets, images, and videos. Note that even for self contained documents MathJax is still loaded externally (this is necessary because of its size).
mathjax	Include mathjax. The "default" option uses an https URL from a MathJax CDN. The "local" option uses a local version of MathJax (which is copied into the output directory). You can pass an alternate URL or pass NULL to exclude MathJax entirely.
df_print	Method to be used for printing data frames. Valid values include "default", "kable", "tibble", and "paged". The "default" method uses a corresponding S3 method of print, typically print.data.frame. The "kable" method uses the knitr::kable function. The "tibble" method uses the tibble package to print a summary of the data frame. The "paged" method creates a paginated HTML table (note that this method is only valid for formats that produce HTML). In addition to the named methods you can also pass an arbitrary function to be used for printing data frames. You can disable the df_print behavior entirely by setting the option rmarkdown.df_print to FALSE. See Data frame printing section in bookdown book for examples.
code_download	Embed the Rmd source code within the document and provide a link that can be used by readers to download the code.
...	Arguments to be passed to a specific output format function rmarkdown::html_document

Value

R Markdown output format to pass to render

mcanouil/mctemplates documentation built on Feb. 25, 2021, 5:17 p.m.