package_docs: Generate package docs

In packagedocs: Build Website of Package Documentation

Description

rmarkdown output formats for the main documentation and package reference pacakge respectively.

Usage

package_docs(toc = TRUE, toc_depth = 2, toc_collapse = FALSE,
  extra_dependencies = NULL, self_contained = FALSE, fig_width = 6.5,
  fig_height = 4, mathjax = NULL, lib_dir = assets_dir(), ...,
  lazyrmd_render_fn = "html_document", lazyrmd_render_package = "rmarkdown")

package_docs_rd(..., rd_index = "rd_index.yaml", code_path = ".",
  exclude = NULL)

Arguments

toc	should a table of contents be included?
toc_depth	depth of the table of contents (max is 2 for this template)
toc_collapse	should the table of contents have collapsible subsections?
extra_dependencies, self_contained, fig_width, fig_height, mathjax	passed to the rmarkdown rendering function
lazyrmd_render_fn, lazyrmd_render_package, lib_dir	arguments of lazyrmd::lazy_render. Defaults to render with rmarkdown::html_document
rd_index, code_path, exclude	parameters passed directly to rd_template
...	In pacakge_docs, the parameters are passed to the lazyrmd::lazy_render rendering function. In package_docs_rd, the parameters are passed to package_docs

packagedocs documentation built on May 2, 2019, 4:18 a.m.