| vignetteCode-class {DynDoc} | R Documentation |
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.
Objects can be created by calls of the form new("vignetteCode", ...)
Also, a helper function getVignetteCode is provided that will do
all of the dirty work required to retrieve a vignetteCode object
from a vignette file.
chunkList:"chunkList" Holds
the code chunks from the vignette filepath:"character" The path of
the vignette file package:"character" The
package (if appropriate) that the vignette came from getDepends:"character" Any
package dependencies for the vignette evalEnv:"environment" An
environment used for evaulation of the code chunks.signature(object = "vignetteCode"): Displays
information about the code contained in the objectsignature(object = "vignetteCode"):
Retrieves the chunkList object.signature(object = "vignetteCode"): Retrieves
the actual code chunks (not wrapped by the chunkList
class)signature(object = "vignetteCode"): Returns
the list of package dependencies for this vignettesignature(object =
"vignetteCode",pos="numeric"): Will evaulate the specified code
chunk in the evalEnv environmentsignature(object = "vignetteCode"): Returns
the evaluation environmentsignature(object =
"vignetteCode",pos="numeric"): Returns the codeChunk
object representing the specified code chunk positionsignature(object = "vignetteCode"): Returns
the number of chunks in the object signature(object = "vignetteCode"): Returns
the package the vignette is a part of signature(object = "vignetteCode"): Returns the
local file path to the vignette signature(object =
"vignetteCode",pos="numeric", value="character"): Resets the
code chunk specified by pos to contain the code specified
by valuesignature(object = "vignetteCode"): A less
verbose output of information then with show Jeff Gentry
Sweave, getVignetteCode,
editVignetteCode, chunkList