\HeaderA{getVignetteHeader}{A function to read vignette header information}{getVignetteHeader}
\aliasA{hasVigHeaderField}{getVignetteHeader}{hasVigHeaderField}
\keyword{utilities}{getVignetteHeader}
\begin{Description}\relax
Given a vignette filename, will read in the vignette header metadata.
\end{Description}
\begin{Usage}
\begin{verbatim}
getVignetteHeader(vig, field)
hasVigHeaderField(vig, field="VignetteIndexEntry")
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{vig}] Vignette filename
\item[\code{field}] A specific field to extract
\end{ldescription}
\end{Arguments}
\begin{Details}\relax
The \code{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 \code{hasVigHeaderField} function is a simple wrapper around
\code{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.
\end{Details}
\begin{Author}\relax
Jeff Gentry
\end{Author}