getPkgVigs: List Vignette Files for a Package

Description Usage Arguments Value Author(s) See Also Examples

View source: R/vignettes.R

Description

This function will return a listing of all vignettes stored in a package's doc directory.

Usage

1
getPkgVigs(package = NULL)

Arguments

package

A character vector of packages to search or NULL. The latter is for all attached packages (in search()).

Value

A data.frame with columns package, filename, title.

Author(s)

Jeff Gentry, modifications by Wolfgang Huber.

See Also

openVignette

Examples

1
2
 z <- getPkgVigs()
 z # and look at them

Bioconductor/Biobase documentation built on June 16, 2018, 10:46 p.m.