compare_versions: Compare versions of a package

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

Description

compare_versions reports how functions and APIs changed between versions of a package.

Usage

compare_versions(package, version = previous_version(package, version2),
  version2, methods = FALSE, quiet = TRUE, ...)

## S3 method for class 'versions_report'
print(x, ...)

## S3 method for class 'versions_report'
summary(object, ...)

Arguments

package	Package name.
version	First version to compare. By default, the previous version to that currently installed.
version2	Second version to compare. By default, the current installed version.
methods	Logical: include non-exported S3 methods?
quiet	Logical. Try to minimize output from package installation. (Some output comes from R CMD INSTALL and may be unavoidable.)
...	Arguments passed to versions::install.versions() or remotes::install_version(), and thence to install.packages(). Ncpus may be useful.
x, object	An object of class versions_report.

Value

compare_versions returns a data frame of class versions_report, reporting functions that have been "Added", "Removed" or had "API changed", and details of function arguments. Extra information is in the "package" and "versions" attributes.

summary returns a string representation of changed function arguments.

Examples

## Not run: 
compare_versions("clipr", "0.2.1", "0.3.0")

## End(Not run)

hughjonesd/pastapi documentation built on Sept. 9, 2019, 12:56 p.m.