getDescription.Package {R.oo}R Documentation

Gets the description of the package

Description

Gets the description of the package. Not to be mixed up with *getDescriptionFile().

Usage

## S3 method for class 'Package':
getDescription(this, replaceNewlines=" ", ...)

Arguments

replaceNewlines If a character string, all newline characters are replaced with this string. Otherwise not.
... Not used.

Value

A character string.

Author(s)

Henrik Bengtsson (http://www.braju.com/R/)

See Also

For more information see Package.

Examples

  pkg <- Package("base")
  print(getDescription(pkg))
[Package R.oo version 1.6.5 Index]