getVignetteInfo
Get Information on Installed Vignettes
This function gets information on installed vignettes.
- Keywords
- utilities, documentation
Usage
getVignetteInfo(package = NULL, lib.loc = NULL, all = TRUE)Arguments
- package
Which package to look in, or
NULLfor all packages.- lib.loc
Which library to look in.
- all
Whether to search all installed packages, or just attached packages.
Value
A matrix with columns
the name of the package
the directory where the package is installed
the name of the vignette
the base filename of the source of the vignette
the title of the vignette
the tangled R source from the vignette
the PDF or HTML file for display
Note
The last column of the result is named PDF for historical reasons,
but it may contain a filename of a PDF or HTML document.
See Also
pkgVignettes is a similar function that can work on
an uninstalled package.
Examples
library(tools)
# NOT RUN {
getVignetteInfo("grid")
# }
Community examples
Looks like there are no examples yet.