DynDoc-class {DynDoc} | R Documentation |
A Class For Dynamic Documents
Description
The DynDoc class is used to represent dynamic documents and vignettes in R.
Slots
indexEntry
:Object of class
"character"
The IndexEntry value from the document filetitle
:Object of class
"character"
The name of the documentpath
:Object of class
"character"
The path to the locally stored filepdfPath
:Object of class
"character"
The path to a PDF rendition of the documentdepends
:Object of class
"character"
Any package dependencies for the documentrequires
:Object of class
"character"
Any requires level dependencies for the documentsuggests
:Object of class
"character"
Any suggests level dependencies for the documentkeywords
:Object of class
"character"
Any keywords for the documentcodeChunks
:Object of class
"chunkList"
The code chunks contained in this document
Methods
- show
signature(object = "DynDoc")
: Display information about the dynamic document- summary
signature(object = "DynDoc")
: A more succinct informational display- chunks
signature(object = "DynDoc")
: Returns the code chunks - currently in only for historical compatability with old code- codeChunks
signature(object = "DynDoc")
: Returns the code chunks- evalChunk
signature(object = "DynDoc")
: Will evaluate the R code contained in a chunk- getChunk
signature(object = "DynDoc")
: Retrieves a specific code chunk- getDepends
signature(object = "DynDoc")
: Obtain the Depends slot of the object- getKeywords
signature(object = "DynDoc")
: Obtain the keywords slot of the object- getRequires
signature(object = "DynDoc")
: A get method for the requires slot of this object- getSuggests
signature(object = "DynDoc")
: Obtain the suggests slot of this object- indexEntry
signature(object = "DynDoc")
: Obtain the indexEntry slot of this object- numChunks
signature(object = "DynDoc")
: Returns the number of code chunks for this document- path
signature(object = "DynDoc")
: Obtain the path slot of this object- pdfPath
signature(object = "DynDoc")
: Obtain the pdfPath slot of this object- setChunk<-
signature(object = "DynDoc")
: Change the code for one of the code chunks.
Author(s)
Jeff Gentry