package_report: Report on backwards compatibility of a source package

In hughjonesd/apicheck: Explore the Historical API of R Packages

Description

package_report lists all external function calls from a source package using pkgapi::map_package(). It then checks backward-compatibility of each call with previous versions.

Usage

package_report(path = ".", include, exclude = core_packages(),
  cutoff_date = Sys.Date() - 2 * 365, max_n_versions = NULL,
  parallel = FALSE, progress = !parallel, ...)

Arguments

path	Path to the root of an R source package.
include	Packages to include. By default, all are included except core packages and the package at path itself.
exclude	Packages to exclude from checking. Overrides include.
cutoff_date	Don't check versions before this date (default: 2 years ago). Set to NULL for no cutoff.
max_n_versions	Check at most this number of previous versions. Set to NULL for no limit.
parallel	Run in parallel.
progress	Show a progress bar.
...	Arguments passed to call_with_namespace().

Value

A data frame with three rows:

• package for the external package

• version for the latest version which caused problems or NA if there were no problems

• funs a list-column of function names where the API changed

Parallelism

For parallel search, you can set up your own parallel cluster by using parallel::setDefaultCluster(); otherwise one will be created, using getOption("cl.cores") cores if that is set. If you set up your own cluster, it will not be stopped automatically (see parallel::stopCluster()).

Examples

## Not run: 
package_report(".")
# to include base packages also:
package_report(".", exclude = character(0))

## End(Not run)

hughjonesd/apicheck documentation built on Sept. 9, 2019, 12:55 p.m.