getVignetteHeader {DynDoc} | R Documentation |
A function to read vignette header information
Description
Given a vignette filename, will read in the vignette header metadata.
Usage
getVignetteHeader(vig, field)
hasVigHeaderField(vig, field="VignetteIndexEntry")
Arguments
vig |
Vignette filename |
field |
A specific field to extract |
Details
The getVignetteHeader
function will extract the metadata from a
vignette file and return it as a named list, where the names of the
list elements correspond to the metadata fields, and the elements
themselves the values. If a specific field is desired, it can be
specified with the 'field' argument.
The hasVigHeaderField
function is a simple wrapper around
getVignetteHeader
and will most likely be removed in the very
near future. It just is a boolean to report if a given header field
exists or not.
Author(s)
Jeff Gentry
[Package DynDoc version 1.74.0 Index]