R.oo (version 1.3.0)

Package: The Package class provides methods for accessing package information

Description

Package: R.oo Class Package Object ~~| ~~+--Package Directly known subclasses: public class Package extends Object Creates a Package that can be thrown and caught. The Package class is the root class of all other Package classes.

Usage

Package(name=NULL)

Arguments

name

Name of the package.

Fields and Methods

Methods: rll{ as.character Gets a string representation of this package. getAuthor Gets the Author of this package. getBundle Gets the Bundle that this package might belong to. getBundlePackages Gets the names of the other packages that is in the same bundle as this package. getChangeLog Gets the change log of this package. getClasses Gets all classes of a package. getContents Gets the contents of this package. getContribUrl Gets the URL(s) from where this package can be installed. getDataPath Gets the path to the data (data/) directory of this package. getDate Gets the date when package was build. getDescription Gets the description of the package. getDescriptionFile Gets the description file of this package. getDevelUrl Gets the URL(s) from where the developers version of this package can be installed. getDocPath Gets the path to the accompanying documentation (doc/) directory of this package. getEnvironment Gets the environment of a loaded package. getExamplePath Gets the path to the example (R-ex/) directory of this package. getHistory - getHowToCite Gets the howToCite of this package. getLicense Gets the License of this package. getMaintainer Gets the Maintainer of this package. getName Gets the name of this package. getPath Gets the library (system) path to this package. getPosition Gets the search path position of the package. getTitle Gets the Title of this package. getUrl Gets the URL of this package. getVersion Gets the version of this package. isLoaded Checks if the package is installed on the search path or not. ll Generates a list of informative properties of all members of the package. load Loads a package. showChangeLog Show the change log of this package. showContents Show the CONTENTS file of this package. showDescriptionFile Show the DESCRIPTION file of this package. showHistory - showHowToCite Show the HOWTOCITE file of this package. unload Unloads a package. update Updates the package is a newer version is available. } Methods inherited from Object: $, $<-, [[, [[<-, as.character, attach, attachLocally, clearCache, clone, detach, equals, extend, finalize, gc, getEnvironment, getFields, getInstanciationTime, getStaticInstance, hasField, hashCode, ll, load, objectSize, print, save

Examples

# By defining .First.lib() as follows in zzz.R for a package, an
# instance of class Package with the same name as the package will
# be made available on the search path. More over, the code below
# will also inform the user that the package has been loaded:
#
#  > library(R.oo)
#  R.oo v0.52 (2003/04/13) was successfully loaded.
#
.First.lib <- function(libname, pkgname) {
  pkg <- Package(pkgname);
  assign(pkgname, pkg, pos=getPosition(pkg));
  cat(getName(pkg), " v", getVersion(pkg), " (", getDate(pkg), ")",
    " was successfully loaded.\n", sep="");
}

# The Package class works for any packages, loaded or not.

# Some information about the base package
pkg <- Package("base")
print(pkg)
# [1] "Package: base v1.6.2 (NA) is loaded (pos=5). The official webpage
#      is NA and the maintainer is R Core Team <[e-mail]>. The
#      package is installed in c:/PROGRA~1/R/rw1062/library/base/."
print(list.files(Package("base")$dataPath))

# Some information about the R.oo package
print(R.oo)
# [1] "Package: R.oo v0.52 (2003/04/13) is loaded (pos=2). The official
#      webpage is http://www.braju.com/R/ and the maintainer is Henrik
#      Bengtsson <[e-mail]>. The package is installed in
#      c:/PROGRA~1/R/rw1062/library/R.oo/."

# To check for updates and update a package, just do
update(R.oo)