\HeaderA{codeChunk-class}{Class "codeChunk"}{codeChunk.Rdash.class}
\aliasA{chunk}{codeChunk-class}{chunk}
\aliasA{chunk,codeChunk-method}{codeChunk-class}{chunk,codeChunk.Rdash.method}
\aliasA{chunk<\Rdash}{codeChunk-class}{chunk<.Rdash.}
\aliasA{chunk<-,codeChunk-method}{codeChunk-class}{chunk<.Rdash.,codeChunk.Rdash.method}
\aliasA{chunkName}{codeChunk-class}{chunkName}
\aliasA{chunkName,codeChunk-method}{codeChunk-class}{chunkName,codeChunk.Rdash.method}
\aliasA{codeChunk}{codeChunk-class}{codeChunk}
\aliasA{evalChunk,codeChunk-method}{codeChunk-class}{evalChunk,codeChunk.Rdash.method}
\aliasA{getOptions,codeChunk-method}{codeChunk-class}{getOptions,codeChunk.Rdash.method}
\aliasA{show,codeChunk-method}{codeChunk-class}{show,codeChunk.Rdash.method}
\aliasA{SweaveOptions,codeChunk-method}{codeChunk-class}{SweaveOptions,codeChunk.Rdash.method}
\keyword{classes}{codeChunk-class}
\begin{Description}\relax
A class to wrap necessary information for a code chunk from
a vignette file.
\end{Description}
\begin{Section}{Objects from the Class}
Objects can be created by calls of the form \code{new("codeChunk", ...)}.
\end{Section}
\begin{Section}{Slots}
\describe{
\item[\code{chunkName}:] Object of class \code{"character"} The name
(if one exists) for the code chunk
\item[\code{chunk}:] Object of class \code{"character"} The code
from the code chunk
\item[\code{options}:] Object of class \code{"SweaveOptions"} Any
options that were set at the time the code chunk appears in the
vignette file
}
\end{Section}
\begin{Section}{Methods}
\describe{
\item[evalChunk] \code{signature(object = "codeChunk",
        env="environment")}: Will evaluate the code in the code chunk
using the environment specified.  If no environment is specified,
.GlobalEnv is used.
\item[show] \code{signature(object = "codeChunk")}: Displays the
information for the code chunk
\item[chunk<-] \code{signature(object = "codeChunk",
        value="character")}: Edits the \code{chunk} slot of the object
\item[chunk] \code{signature(object = "codeChunk")}: Returns the
\code{chunk} slot of the object
\item[chunkName] \code{signature(object = "codeChunk")}: Returns the
name of the code chunk
\item[getOptions] \code{signature(object = "codeChunk")}: Returns
the actual options from the \code{options} slot. 
\item[SweaveOptions] \code{signature(object = "codeChunk")}: Returns
the object stored in the \code{options} slot.
}
\end{Section}
\begin{Author}\relax
Jeff Gentry
\end{Author}
\begin{SeeAlso}\relax
\code{\LinkA{Sweave}{Sweave}}, \code{\LinkA{SweaveOptions}{SweaveOptions}}, \code{\LinkA{chunkList}{chunkList}}
\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}
    library(tools)
    testfile <- file.path(.path.package("tools"),
                           "Sweave", "Sweave-test-1.Rnw")
    if (file.exists(testfile)) {
        z <- Stangle(testfile,driver=tangleToR)
        getChunk(z,1)
    }
\end{ExampleCode}
\end{Examples}