DynDoc-class: 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 file title
:- Object of class
"character"
The name of
the document path
:- Object of class
"character"
The path to
the locally stored file pdfPath
:- Object of class
"character"
The path
to a PDF rendition of the document depends
:- Object of class
"character"
Any
package dependencies for the document requires
:- Object of class
"character"
Any
requires level dependencies for the document suggests
:- Object of class
"character"
Any
suggests level dependencies for the document keywords
:- Object of class
"character"
Any
keywords for the document codeChunks
:- 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.