packageDescription
Read a Package's DESCRIPTION File
Description
Reads the DESCRIPTION file, or specific fields from the DESCRIPTION file, for the specified package.
Usage
packageDescription(pkg, lib.loc = NULL, fields = NULL, drop = TRUE,
encoding = "")
packageVersion(pkg, lib.loc = NULL)
maintainer(pkg)
Arguments
| pkg |
a character string specifying the package name.
|
| lib.loc |
a character vector specifying the library directories where pkg
is installed.
The default searches the library directories given by .libPaths().
|
| fields |
a character vector specifying the tags in the DESCRIPTION file to return.
The default is to return all fields.
|
| drop |
a logical value. If TRUE (the default),
and the length of fields is one,
then a single character string is returned instead of an object
of class "packageDescription".
|
| encoding |
the string encoding (see Encoding) to use for newly-created strings.
In TIBCO Enterprise Runtime for R, this argument is not implemented.
If this argument is specified, a warning is generated.
|
Value
| packageDescription | returns an object of class "packageDescription".
You can use a print method to display this returned object.
The object "packageDescription" includes
a "file" attribute that indicates the file system
location of the DESCRIPTION file.
Returns a single character string containing the fields
value from the DESCRIPTION file if drop=TRUE and the fields is of length one.
|
| packageVersion | returns the version (as a package_version object). |
| maintainer | returns the the maintainer (as a string containing an email address)
of the package. |
.
Differences between TIBCO Enterprise Runtime for R and Open-source R
In TIBCO Enterprise Runtime for R, the encoding argument is not implemented.
If this argument is given, a warning is generated.
See Also
Examples
packageDescription("base") # the base TIBCO Enterprise Runtime for R package description
packageDescription("arbor") # the arbor package description
maintainer("stats") # email address for questions about this package
packageVersion("stats") # the version of the package.