\HeaderA{Vignette-class}{A Class To Represent Vignettes}{Vignette.Rdash.class}
\aliasA{vigPackage,Vignette-method}{Vignette-class}{vigPackage,Vignette.Rdash.method}
\aliasA{vigPkgVersion}{Vignette-class}{vigPkgVersion}
\aliasA{vigPkgVersion,Vignette-method}{Vignette-class}{vigPkgVersion,Vignette.Rdash.method}
\keyword{classes}{Vignette-class}
\begin{Description}\relax
This is a class that will represent a vignette file in R,
it extends the DynDoc class
\end{Description}
\begin{Section}{Slots}
\describe{
\item[\code{package}:] Object of class \code{"character"} The
package that this vignette is associated with
\item[\code{vigPkgVersion}:] Object of class \code{"VersionNumber"} The
version number for this vignette's package
\item[\code{indexEntry}:] Object of class \code{"character", from
        class "DynDoc"} The VignetteIndexEntry field from the document file
\item[\code{title}:] Object of class \code{"character", from class
        "DynDoc"} The title of the vignette
\item[\code{path}:] Object of class \code{"character", from class
        "DynDoc"} The path to the vignette file stored locally
\item[\code{pdfPath}:] Object of class \code{"character", from class
        "DynDoc"} The path to a PDF representation of the vignette
\item[\code{depends}:] Object of class \code{"character", from class
        "DynDoc"} Any package dependencies for this vignette
\item[\code{requires}:] Object of class \code{"character", from
        class "DynDoc"} Any requires level dependencies for this vignette
\item[\code{suggests}:] Object of class \code{"character", from
        class "DynDoc"} Any suggests level dependencies for this vignette
\item[\code{keywords}:] Object of class \code{"character", from
        class "DynDoc"} Any keywords for this vignette
\item[\code{codeChunks}:] Object of class \code{"chunkList", from
        class "DynDoc"} A list of code chunks from this vignette
}
\end{Section}
\begin{Section}{Extends}
Class \code{"DynDoc"}, directly.
\end{Section}
\begin{Section}{Methods}
\describe{
\item[package] \code{signature(object = "Vignette")}: Retrieves the
package name that this vignette is associated with
\item[vigPkgVersion] \code{signature(object = "Vignette")}: Retrieves
the version of the package that this vignette is associated with
}
\end{Section}
\begin{Note}\relax
The \code{Vignette} class is extending the \code{DynDoc} class by
further associating the \code{DynDoc} concepts with a specific R
package.
\end{Note}
\begin{Author}\relax
Jeff Gentry
\end{Author}
\begin{SeeAlso}\relax
\code{\LinkA{DynDoc-class}{DynDoc.Rdash.class}}, \code{\LinkA{Sweave}{Sweave}}
\end{SeeAlso}