getVignette: A function to handle vignette files

Description Usage Arguments Details Value Author(s) See Also

Description

This function will take a vignette file and return a Vignette object in R which can be manipulated further.

Usage

1
getVignette(vigPath, eval = TRUE)

Arguments

vigPath

The file path of the vignette file

eval

Whether or not to evaluate the code chunks

Details

This function should still be considered experimental

Value

A valid Vignette object representing this vignette

Author(s)

Jeff Gentry

See Also

Vignette-class



Search within the DynDoc package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.