Regular Expression Library Documentation

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.

Examples

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

See also