Vignette-class: A Class To Represent Vignettes

In Bioconductor/DynDoc: Dynamic document tools

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 with

vigPkgVersion:

Object of class "VersionNumber" The version number for this vignette's package

indexEntry:

Object of class "character", from class "DynDoc" The VignetteIndexEntry field from the document file

title:

Object of class "character", from class "DynDoc" The title of the vignette

path:

Object of class "character", from class "DynDoc" The path to the vignette file stored locally

pdfPath:

Object of class "character", from class "DynDoc" The path to a PDF representation of the vignette

depends:

Object of class "character", from class "DynDoc" Any package dependencies for this vignette

requires:

Object of class "character", from class "DynDoc" Any requires level dependencies for this vignette

suggests:

Object of class "character", from class "DynDoc" Any suggests level dependencies for this vignette

keywords:

Object of class "character", from class "DynDoc" Any keywords for this vignette

codeChunks:

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

See Also

DynDoc-class, Sweave

Bioconductor/DynDoc documentation built on Nov. 2, 2024, 6:34 a.m.