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

# 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

Henrik Bengtsson

See also

For more information see Package.

Examples

  pkg <- Package("base")
  print(getDescription(pkg))
#> [1] "Base R functions."