check_upstream_repository: identifies if a package indicates it has a versioned...

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

Description

A crucial element of good software is software that users can patch (or at least complain about). check_upstream_repository consumes package metadata and identifies from it if users are provided with an actual versioning system, or contact email, to forward issues or fixes to.

Usage

check_upstream_repository(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

check_upstream_repository works by checking the "URL" and "BugReports" fields of the most recent package release - since these are the fields most likely to contain a valid pointer to an upstream source - for anything that case-insensitively matches "github", "r-forge", "bitbucket" or "@" (for email addresses). If one is matched, that's the value. If none are matched, "None/Other".

Value

"GitHub", "R-Forge", "BitBucket", "Email" or "None/Other".

See Also

see the package index for more checks.

Examples

## Not run: 
#urltools uses GitHub. Let's see if we can identify that.
urltools_metadata <- get_package_metadata("urltools")
check_upstream_repository(urltools_metadata)

#tm uses R-Forge
tm_metadata <- get_package_metadata("tm")
check_upstream_repository(tm_metadata)

## End(Not run)

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