vignetteCode-class: Class "vignetteCode"
Description
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 from the Class
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.Slots
chunkList
:- Object of class
"chunkList"
Holds
the code chunks from the vignette file path
:- Object of class
"character"
The path of
the vignette file vigPackage
:- Object of class
"character"
The
package (if appropriate) that the vignette came from depends
:- Object of class
"character"
Any
package dependencies for the vignette evalEnv
:- Object of class
"environment"
An
environment used for evaluation of the code chunks.
Methods
- show
signature(object = "vignetteCode")
: Displays
information about the code contained in the object - chunkList
signature(object = "vignetteCode")
:
Retrieves the chunkList
object. - chunks
signature(object = "vignetteCode")
: Retrieves
the actual code chunks (not wrapped by the chunkList
class) - getDepends
signature(object = "vignetteCode")
: Returns
the list of package dependencies for this vignette - evalChunk
signature(object =
"vignetteCode",pos="numeric")
: Will evaulate the specified code
chunk in the evalEnv
environment - evalEnv
signature(object = "vignetteCode")
: Returns
the evaluation environment - getChunk
signature(object =
"vignetteCode",pos="numeric")
: Returns the codeChunk
object representing the specified code chunk position - numChunks
signature(object = "vignetteCode")
: Returns
the number of chunks in the object - vigPackage
signature(object = "vignetteCode")
: Returns
the package the vignette is a part of - path
signature(object = "vignetteCode")
: Returns the
local file path to the vignette - setChunk<-
signature(object =
"vignetteCode",pos="numeric", value="character")
: Resets the
code chunk specified by pos
to contain the code specified
by value
- summary
signature(object = "vignetteCode")
: A less
verbose output of information then with show