PackageDetail-class

Class "PackageDetail"

Representation of R package metadata. Most slots correspond to fields in a package's DESCRIPTION file.

Keywords
classes
Objects from the Class

Objects can be created by calls of the form new("PackageDetail", ...).

Slots

Package:
Object of class "character" see DESCRIPTION
Version:
Object of class "character" see DESCRIPTION
Title:
Object of class "character" see DESCRIPTION
Description:
Object of class "character" see DESCRIPTION
Author:
Object of class "character" see DESCRIPTION
Maintainer:
Object of class "character" see DESCRIPTION
Depends:
Object of class "character" see DESCRIPTION
Imports:
Object of class "character" see DESCRIPTION
Suggests:
Object of class "character" see DESCRIPTION
SystemRequirements:
Object of class "character" see DESCRIPTION
License:
Object of class "character" see DESCRIPTION
URL:
Object of class "character" see DESCRIPTION
biocViews:
Object of class "character" see DESCRIPTION
vignettes:
Object of class "character" giving paths to vignette pdf files in the repository
vignetteScripts:
Object of class "character" giving paths to vignette Stangled R files in the repository
vignetteTitles:
Object of class "character" giving the titles of the vignette files in the repository
source.ver:
Object of class "character" version string for the source package
win.binary.ver:
Object of class "character" version string for the 32-bit Windows binary package
win64.binary.ver:
Object of class "character" version string for the 64-bit Windows binary package
mac.binary.leopard.ver:
Object of class "character" version string for the OS X Leopard binary package
downloadStatsUrl:
Object of class "character" An optional URL for the download history statistics.
manuals:
Object of class "character" giving paths to reference manual pdf files in the repository
dependsOnMe:
Object of class "character" giving packages found in the repository that depend on this package
importsMe:
Object of class "character" giving packages found in the repository that imports this package
suggestsMe:
Object of class "character" giving packages found in the repository that suggest this package
functionIndex:
Object of class "character" Not used. Intended to hold function index data.
reposFullUrl:
Object of class "character" The URL for the full URL of the root of the repository.
reposRoot:
Object of class "character" The URL for the root of the repository.
viewRoot:
Object of class "character" The URL for the view of the repository.
devHistoryUrl:
Object of class "character" The URL for the development changelog.

Extends

Class "Htmlized", directly.

Methods

htmlDoc
signature(object = "PackageDetail"): Return an XMLNode instance containg a complete HTML document representation of the package.
htmlFilename
signature(object = "PackageDetail"): Return a filename appropriate for the HTML document representation.
htmlValue
signature(object = "PackageDetail"): Return XMLNode instance containing an HTML representation of the package.

Details

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")

Aliases
  • PackageDetail-class
  • pdAuthorMaintainerInfo-class
  • pdVignetteInfo-class
  • pdDownloadInfo-class
  • pdDetailsInfo-class
  • pdDescriptionInfo-class
  • pdVigsAndDownloads-class
  • htmlDoc,PackageDetail-method
  • htmlFilename,PackageDetail-method
  • htmlValue,PackageDetail-method
  • htmlValue,pdAuthorMaintainerInfo-method
  • htmlValue,pdVignetteInfo-method
  • htmlValue,pdDownloadInfo-method
  • htmlValue,pdDetailsInfo-method
  • htmlValue,pdDescriptionInfo-method
  • htmlValue,pdVigsAndDownloads-method
Examples
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",
          Imports="ASimplePackage",
          Suggests="MyDataPackage",
          biocViews="Infrastructure",
          vignettes="vignettes/MyFancyPackage/inst/doc/MFP1.pdf,\nvignettes/MyFancyPackage/inst/doc/MFP2.pdf",
          vignetteScripts="vignettes/MyFancyPackage/inst/doc/MFP1.R\nvignettes/MyFancyPackage/inst/doc/MFP2.R",
          vignetteTitles="MFP1 Document,\nMFP2 Document",
          source.ver="src/contrib/MyFancyPackage_1.2.3.tar.gz",
          win.binary.ver="bin/windows/contrib/2.6/MyFancyPackage_1.2.2.zip",
          win64.binary.ver="bin/windows64/contrib/2.6/MyFancyPackage_1.2.2.zip",
          mac.binary.leopard.ver="bin/macosx/leopard/contrib/2.6/MyFancyPackage_1.2.3.tgz",
          dependsOnMe=c("PackageThatExposesMe"),
          importsMe=c("AnEvenFancierPackage","AMuchFancierPackage"),
          suggestsMe="PackageThatUsesMeInVignette",
          reposRoot="http://foo.bar.org")

html <- htmlValue(pd)
pd

Documentation reproduced from package biocViews, version 1.40.1, License: Artistic-2.0

Community examples

Looks like there are no examples yet.