vignette {DynDoc}R Documentation

Vignettes

Description

Retrieves information about the vignettes from either all packages or a set of specific packages.

Usage

vignette(package=.packages(all.available=TRUE), libs, filter,
         vigDescFun=baseVigDesc, vigPath="/doc")

Arguments

package A name or character vector giving the packages to look into for vignettes. By default, all packages in the search path are used.
libs A character vector of directory names representing R libraries. If provided these directories will be where the system searches for packages, otherwise .libPaths() is used.
filter Allows for filtering of vignettes from display
vigDescFun Function to provide output string for display
vigPath Directory path in a package directory for vignettes

Details

This function will look at a set of packages and extract information from any vignettes that are available. It will then return a pkgFileList object describing these vignettes.

Author(s)

Jeff Gentry

See Also

openVignette, vExplorer

Examples

   vignette()

[Package Contents]