R.oo (version 1.21.0)

getDescription.Package: Gets the description of the package

Description

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

Usage

# S3 method for 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.

See Also

For more information see Package.

Examples

# NOT RUN {
  pkg <- Package("base")
  print(getDescription(pkg))
# }