getChangeLog.Package: Gets the change log of this package

getChangeLog.PackageR Documentation

Gets the change log of this package

Description

Gets the change log of this package, that is, (by default) the NEWS (then the HISTORY and ChangeLog) file, which should is expected to be located in the root directory of the package, i.e. *getPath().

Usage

## S3 method for class 'Package'
getChangeLog(this, filenames=c("NEWS", "HISTORY", "ChangeLog"), newline="\n", ...)

Arguments

filenames

A character vector of (non-case sensitive) filenames to be searched for.

newline

The character string to collapse lines in the file.

...

Not used.

Value

Returns the complete contents of the change log file as a character string. If not found, NULL is returned.

Author(s)

Henrik Bengtsson

See Also

For more information see Package.


R.oo documentation built on Nov. 2, 2024, 1:07 a.m.