CRANtools: CRAN Package Repository Tools

Description

Tools for obtaining information about current packages in the CRAN package repository, and their check status.

Usage

CRAN_package_db()
CRAN_check_results(flavors = NULL)
CRAN_check_details(flavors = NULL)
CRAN_memtest_notes()
summarize_CRAN_check_status(packages,
                            results = NULL,
                            details = NULL,
                            mtnotes = NULL)

Arguments

packages

a character vector of package names.

flavors

a character vector of CRAN check flavor names, or NULL (default), corresponding to all available flavors.

results

the return value of CRAN_check_results() (default), or a subset of this.

details

the return value of CRAN_check_details() (default), or a subset of this.

mtnotes

the return value of CRAN_check_mtnotes() (default), or a subset of this.

Value

See ‘Details’. Note that the results are collated on CRAN: currently this is done in a locale which sorts aAbB ….

Which CRAN?

The main functions access a CRAN mirror specified by the environment variable R_CRAN_WEB, defaulting to one specified in the repositories file (see setRepositories): if that specifies @CRAN@ (the default) then https://CRAN.R-project.org is used. (Note that options("repos") is not consulted.) Note that these access parts of CRAN under web/contrib and web/packages so if you have specified a mirror of just src/contrib for installing packages you will need to set R_CRAN_WEB to point to a full mirror.

Details

CRAN_package_db() returns a character data frame with most DESCRIPTION metadata for the current packages in the CRAN package repository, including in particular the Description and Maintainer information not provided by utils::available.packages(). CRAN_check_results() returns a data frame with the basic CRAN package check results including timings, with columns Package, Flavor and Status giving the package name, check flavor, and overall check status, respectively. CRAN_check_details() returns a data frame inheriting from class "check_details" (which has useful print and format methods) with details on the check results, providing check name, status and output for every non-OK check (via columns Check, Status and Output, respectively). Packages with all-OK checks are indicated via a * Check wildcard name and OK Status. CRAN_memtest_notes() returns pointers to issues identified in the additional memory-access check results made available from https://www.stats.ox.ac.uk/pub/bdr/memtests/, as a list which for every package with such issues provides a character matrix with columns Test and Path.