repo_status: Show the status of CRAN-like repositories

In r-lib/pkgcache: Cache 'CRAN'-Like Metadata and R Packages

Show the status of CRAN-like repositories

Description

It checks the status of the configured or supplied repositories, for the specified platforms and R versions.

Usage

repo_status(
  platforms = default_platforms(),
  r_version = getRversion(),
  bioc = TRUE,
  cran_mirror = default_cran_mirror()
)

Arguments

platforms	Platforms to use, default is default_platforms().
r_version	R version(s) to use, the default is the current R version, via getRversion().
bioc	Whether to add the Bioconductor repositories. If you already configured them via options(repos), then you can set this to FALSE. See bioc_version() for the details about how pkgcache handles Bioconductor repositories.
cran_mirror	The CRAN mirror to use, see default_cran_mirror().

Details

The returned data frame has a summary() method, which shows the same information is a concise table. See examples below.

Value

A data frame that has a row for every repository, on every queried platform and R version. It has these columns:

• name: the name of the repository. This comes from the names of the configured repositories in options("repos"), or added by pkgcache. It is typically CRAN for CRAN, and the current Bioconductor repositories are BioCsoft, BioCann, BioCexp, BioCworkflows, BioCbooks.

• url: base URL of the repository.

• bioc_version: Bioconductor version, or NA for non-Bioconductor repositories.

• username: Included if at least one repository is authenticated. NA_character_ for repositories without authentication. See repo_auth().

• has_password: TRUE is the function could retrieve the password for the authenticated repository. It is NA for repositories without authentication. This column is included only if at least one repository has authentication. See repo_auth().

• platform: platform, see default_platforms() for possible values.

• path: the path to the packages within the base URL, for a given platform and R version.

• r_version: R version, one of the specified R versions.

• ok: Logical flag, whether the repository contains a metadata file for the given platform and R version.

• ping: HTTP response time of the repository in seconds. If the ok column is FALSE, then this columns in NA.

• error: the error object if the HTTP query failed for this repository, platform and R version.

See Also

Other repository functions: repo_get()

Examples

repo_status()
rst <- repo_status(
  platforms = c("windows", "macos"),
  r_version = c("4.0", "4.1")
)
summary(rst)

r-lib/pkgcache documentation built on March 1, 2025, 5:52 a.m.