check_versioning: identify if a package is semantically versioned

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

Description

take a package's metadata and identify from it whether the package follows the "semantic versioning" convention, at least in theory. See details for, well, details.

Usage

check_versioning(package_metadata)

Arguments

package_metadata

package metadata retrieved with get_package_metadata, or the name of a package (in which case get_package_metadata will be called internally).

Details

semantic versioning is a convention for identifying version numbers of a codebase in a way that distinguishes major changes, minor changes and patches by using three period-separated groups of digits. As an example, 2.0.0 is semantically versioned; 2.0 is not.

check_versioning takes the latest package version number found in package_metadata and identifies whether it follows this format (TRUE) or does not (FALSE).

Value

TRUE if the package does follow the semantic versioning standard, FALSE if not.

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

#Identify if ggplot2 is semantically versioned (it is)
ggplot_metadata <- get_package_metadata("ggplot2")
check_versioning(ggplot_metadata)

#Identify if fbRanks is semantically versioned (it isn't)
fbranks_metadata <- get_package_metadata("fbRanks")
check_versioning(fbranks_metadata)

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