check_changelog: identify if the package contains a changelog

In Ironholds/practice: Tools for identifying whether R packages follow common software engineering conventions

Description

searches through the downloaded source code of a package trying to identify if it has something that looks like a log of changes between versions.

Usage

check_changelog(package_directory)

Arguments

package_directory

the directory the package source code lives in, returned from get_package_source.

Details

changelogs - logs of what changes in a package between versions, be that bug fixes, new features or alterations to how existing features function - are common to R packages and collections of code generally.

With R packages, they are normally stored as "NEWS" or "CHANGELOG" files. check_changelog checks for the presence of a changelog by seeing if there are any files in the root directory of the package source code that match the case-insensitive regular expression "(change|news)".

Value

TRUE if the package has something that looks like a changelog, FALSE otherwise.

See Also

check_vignettes to identify if a package has vignettes and how they are built, check_roxygen to see if inline documentation is built with roxygen2, and the package index for more tests and checks.

Examples

## Not run: 
#Does A3 have a changelog? (yes)
file_location <- get_package_source("A3")
result <- check_changelog(file_location)

#What about "fortunes"? (no)
file_location <- get_package_source("fortunes")
result <- check_changelog(file_location)

## End(Not run)

Ironholds/practice documentation built on May 7, 2019, 6:41 a.m.