getPkgVigList: This function will look at all vignette files in the directory
/
. It will then extract any header information (using
getVigInfo
), and return a list of this information. getVigInfo: This function will retrieve the metadata from a
particular vignette file. Any line starting with '%\Vignette' is
taken to be metadata. Common values include VignetteIndexEntry (required),
VignetteKeywords, VignetteDepends, etc. A named list of lists is
returned to the user, where the names correspond to the particular
metadata variable.
Both functions take a parameter baseVigDesc
, which is a
function to provide the output string to correspond with a vignette
summary. This function is directly called by getVigInfo
. It
takes one parameter, which is a vigInfo list from getVigInfo
.