Vignette-class {DynDoc} | R Documentation |
A Class To Represent Vignettes
Description
This is a class that will represent a vignette file in R, it extends the DynDoc class
Slots
package
:Object of class
"character"
The package that this vignette is associated withvigPkgVersion
:Object of class
"VersionNumber"
The version number for this vignette's packageindexEntry
:Object of class
"character", from class "DynDoc"
The VignetteIndexEntry field from the document filetitle
:Object of class
"character", from class "DynDoc"
The title of the vignettepath
:Object of class
"character", from class "DynDoc"
The path to the vignette file stored locallypdfPath
:Object of class
"character", from class "DynDoc"
The path to a PDF representation of the vignettedepends
:Object of class
"character", from class "DynDoc"
Any package dependencies for this vignetterequires
:Object of class
"character", from class "DynDoc"
Any requires level dependencies for this vignettesuggests
:Object of class
"character", from class "DynDoc"
Any suggests level dependencies for this vignettekeywords
:Object of class
"character", from class "DynDoc"
Any keywords for this vignettecodeChunks
:Object of class
"chunkList", from class "DynDoc"
A list of code chunks from this vignette
Extends
Class "DynDoc"
, directly.
Methods
- package
signature(object = "Vignette")
: Retrieves the package name that this vignette is associated with- vigPkgVersion
signature(object = "Vignette")
: Retrieves the version of the package that this vignette is associated with
Note
The Vignette
class is extending the DynDoc
class by
further associating the DynDoc
concepts with a specific R
package.
Author(s)
Jeff Gentry