library_vignette: Regular Expression Library Documentation

In trinker/regextools: A Regular Expression Documentation, Testing, and Storage Framework

Description

Generate a regular expression library package vignette or Rmd/html/md document.

Usage

library_vignette(path, out = file.path(path, "vignettes"),
  is.vignette = TRUE, include.html = !is.vignette, include.md = FALSE,
  theme = "cerulean", iframe = FALSE, quiet = TRUE, ...)

Arguments

path	The path to the regular expression library package.
out	The directory to output the documents.
is.vignette	logical. Is this an actual package vignette or rendered html/md reference document.
include.html	logical. If TRUE an .html rendering of the .Rmd file is generated.
include.md	logical. If TRUE a .md rendering of the .Rmd file is generated.
theme	A valid Bootstrap theme (see: RStudio Themes).
iframe	logical If TRUE the Debuggex is included as an iframe rather than a link.
quiet	logical. If FALSE render does not print to the console.
...	Other arguments passed to internal functions.

Value

Generates a .Rmd document and optionally .html/.md versions.

See Also

render

Examples

## Not run: 
library_vignette(system.file("sample", package = "regextools"), "vignette",
    is.vignette = FALSE, include.html=TRUE, document = FALSE, install = FALSE)

## End(Not run)

trinker/regextools documentation built on May 31, 2019, 9:51 p.m.