\HeaderA{vignetteCode-class}{Class "vignetteCode"}{vignetteCode.Rdash.class}
\aliasA{chunkList,vignetteCode-method}{vignetteCode-class}{chunkList,vignetteCode.Rdash.method}
\aliasA{chunks,vignetteCode-method}{vignetteCode-class}{chunks,vignetteCode.Rdash.method}
\aliasA{evalChunk}{vignetteCode-class}{evalChunk}
\aliasA{evalChunk,vignetteCode-method}{vignetteCode-class}{evalChunk,vignetteCode.Rdash.method}
\aliasA{evalEnv}{vignetteCode-class}{evalEnv}
\aliasA{evalEnv,vignetteCode-method}{vignetteCode-class}{evalEnv,vignetteCode.Rdash.method}
\aliasA{getChunk,vignetteCode-method}{vignetteCode-class}{getChunk,vignetteCode.Rdash.method}
\aliasA{getDepends}{vignetteCode-class}{getDepends}
\aliasA{getDepends,vignetteCode-method}{vignetteCode-class}{getDepends,vignetteCode.Rdash.method}
\aliasA{numChunks,vignetteCode-method}{vignetteCode-class}{numChunks,vignetteCode.Rdash.method}
\aliasA{path}{vignetteCode-class}{path}
\aliasA{path,vignetteCode-method}{vignetteCode-class}{path,vignetteCode.Rdash.method}
\aliasA{setChunk<-,vignetteCode-method}{vignetteCode-class}{setChunk<.Rdash.,vignetteCode.Rdash.method}
\aliasA{show,vignetteCode-method}{vignetteCode-class}{show,vignetteCode.Rdash.method}
\aliasA{summary,vignetteCode-method}{vignetteCode-class}{summary,vignetteCode.Rdash.method}
\aliasA{vignetteCode}{vignetteCode-class}{vignetteCode}
\aliasA{vigPackage}{vignetteCode-class}{vigPackage}
\aliasA{vigPackage,vignetteCode-method}{vignetteCode-class}{vigPackage,vignetteCode.Rdash.method}
\keyword{classes}{vignetteCode-class}
\begin{Description}\relax
This class represents the code chunks and other related
information from a vignette file.  It also provides for the ability to
evaulate the code chunks in a separate environment.
\end{Description}
\begin{Section}{Objects from the Class}
Objects can be created by calls of the form \code{new("vignetteCode", ...)}
Also, a helper function \code{getVignetteCode} is provided that will do
all of the dirty work required to retrieve a \code{vignetteCode} object
from a vignette file.
\end{Section}
\begin{Section}{Slots}
\describe{
\item[\code{chunkList}:] Object of class \code{"chunkList"} Holds
the code chunks from the vignette file
\item[\code{path}:] Object of class \code{"character"} The path of
the vignette file 
\item[\code{package}:] Object of class \code{"character"} The
package (if appropriate) that the vignette came from 
\item[\code{getDepends}:] Object of class \code{"character"} Any
package dependencies for the vignette 
\item[\code{evalEnv}:] Object of class \code{"environment"} An
environment used for evaulation of the code chunks.
}
\end{Section}
\begin{Section}{Methods}
\describe{
\item[show] \code{signature(object = "vignetteCode")}: Displays
information about the code contained in the object
\item[chunkList] \code{signature(object = "vignetteCode")}:
Retrieves the \code{chunkList} object.
\item[chunks] \code{signature(object = "vignetteCode")}: Retrieves
the actual code chunks (not wrapped by the \code{chunkList}
class) 
\item[getDepends] \code{signature(object = "vignetteCode")}: Returns
the list of package dependencies for this vignette
\item[evalChunk] \code{signature(object =
        "vignetteCode",pos="numeric")}: Will evaulate the specified code
chunk in the \code{evalEnv} environment
\item[evalEnv] \code{signature(object = "vignetteCode")}: Returns
the evaluation environment
\item[getChunk] \code{signature(object =
        "vignetteCode",pos="numeric")}: Returns the \code{codeChunk}
object representing the specified code chunk position 
\item[numChunks] \code{signature(object = "vignetteCode")}: Returns
the number of chunks in the object 
\item[vigPackage] \code{signature(object = "vignetteCode")}: Returns
the package the vignette is a part of 
\item[path] \code{signature(object = "vignetteCode")}: Returns the
local file path to the vignette 
\item[setChunk<-] \code{signature(object =
        "vignetteCode",pos="numeric", value="character")}: Resets the
code chunk specified by \code{pos} to contain the code specified 
by \code{value} 
\item[summary] \code{signature(object = "vignetteCode")}: A less
verbose output of information then with \code{show} 
}
\end{Section}
\begin{Author}\relax
Jeff Gentry
\end{Author}
\begin{SeeAlso}\relax
\code{\LinkA{Sweave}{Sweave}}, \code{\LinkA{getVignetteCode}{getVignetteCode}},
\code{\LinkA{editVignetteCode}{editVignetteCode}}, \code{\LinkA{chunkList}{chunkList}}
\end{SeeAlso}