PackageDetail-class {biocViews} | R Documentation |
Representation of R package metadata. Most slots correspond to fields in a package's DESCRIPTION file.
Objects can be created by calls of the form new("PackageDetail", ...)
.
Package
:"character"
see DESCRIPTION Version
:"character"
see
DESCRIPTION Title
:"character"
see
DESCRIPTION Description
:"character"
see
DESCRIPTION Author
:"character"
see DESCRIPTION Maintainer
:"character"
see
DESCRIPTION Depends
:"character"
see DESCRIPTION Suggests
:"character"
see DESCRIPTION Imports
:"character"
see DESCRIPTION SystemRequirements
:"character"
see DESCRIPTION License
:"character"
see DESCRIPTION URL
:"character"
see DESCRIPTION biocViews
:"character"
see
DESCRIPTION vignettes
:"character"
giving
paths to vignette pdf files in the repository source.ver
:"character"
version
string for the source packagewin.binary.ver
:"character"
version string for the Windows binary package mac.binary.ver
:"character"
version string for the OS X binary package manuals
:"character"
Not used.
Intended to hold paths to pdf manuals in the repositorydependsOnMe
:"character"
giving
packages found in the repository that depend on this packagesuggestsMe
:"character"
giving
packages found in the repository that suggest this packagefunctionIndex
:"character"
Not
used. Intended to hold function index data. reposRoot
:"character"
The URL
for the root of the repository.
Class "Htmlized"
, directly.
signature(object = "PackageDetail")
: Return an
XMLNode
instance containg a complete HTML document
representation of the package.signature(object = "PackageDetail")
:
Return a filename appropriate for the HTML document representation. signature(object = "PackageDetail")
: Return
XMLNode
instance containing an HTML representation of the package.
pdAuthorMaintainerInfo-class
pdVignetteInfo-class
pdDownloadInfo-class
pdDetailsInfo-class
pdDescriptionInfo-class
pdVigsAndDownloads-class
Dummy classes for HTML generation. Each dummy class is a simple
extension (it does not add any slots). The purpose of each dummy
class is to allow for method dispatch to generate HTML via the
htmlValue
method.
You can convert convert a PackageDetail
instance to one of the
dummy classes like this: descInfo <- as(pdObj,
"pdDescriptionInfo")
Seth Falcon
pd <- new("PackageDetail", Package="MyFancyPackage", Version="1.2.3", Title="A Fancy Package", Description="This package does fancy things", Author="A. Coder", Maintainer="A. Coder <acoder@foo.bar.net>", Depends="methods", vignettes=c("vignettes/MyFancyPackage/inst/doc/MFP1.pdf", "vignettes/MyFancyPackage/inst/doc/MFP2.pdf"), source.ver="src/contrib/MyFancypackage_1.2.3.tar.gz", win.binary.ver="bin/windows/contrib/2.3/MyFancyPackge_1.2.2.zip", dependsOnMe="AnEvenFancierPackage", reposRoot="http://foo.bar.org") html <- htmlValue(pd) pd