Skip to content

Show the status of CRAN-like repositories

Source: R/repo-status.R
repo_status.Rd

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().

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.

Details

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

See also

Other repository functions: repo_get()

Examples

repo_status()
#> # A data frame: 7 × 10
#>   name    url   type  bioc_version platform path  r_version ok     ping
#>   <chr>   <chr> <chr> <chr>        <chr>    <chr> <chr>     <lgl> <dbl>
#> 1 RSPM    http… cran… NA           source   src/… 4.5       TRUE  0.206
#> 2 CRAN    http… cran  NA           source   src/… 4.5       TRUE  0.186
#> 3 BioCso… http… bioc  3.21         source   src/… 4.5       TRUE  0.186
#> 4 BioCann http… bioc  3.21         source   src/… 4.5       TRUE  0.193
#> 5 BioCexp http… bioc  3.21         source   src/… 4.5       TRUE  0.197
#> 6 BioCwo… http… bioc  3.21         source   src/… 4.5       TRUE  0.196
#> 7 BioCbo… http… bioc  3.21         source   src/… 4.5       TRUE  0.202
#> # ℹ 1 more variable: error <list>
rst <- repo_status(
  platforms = c("windows", "macos"),
  r_version = c("4.0", "4.1")
)
summary(rst)
#> Repository summary:                               i386+x86_64-w64-mingw32 x86_64-apple-darwin17.0          
#> RSPM          @ packagemanager.posit.co (R 4.0)              ✔                       ✔              (1s   )
#> CRAN          @ cran.rstudio.com        (R 4.0)              ✔                       ✔              (193ms)
#> RSPM          @ packagemanager.posit.co (R 4.1)              ✔                       ✔              (601ms)
#> CRAN          @ cran.rstudio.com        (R 4.1)              ✔                       ✔              (193ms)
#> BioCsoft      @ bioconductor.org        (R 4.0)              ✔                       ✔              (716ms)
#> BioCann       @ bioconductor.org        (R 4.0)              ✔                       ✔              (1s   )
#> BioCexp       @ bioconductor.org        (R 4.0)              ✔                       ✔              (867ms)
#> BioCworkflows @ bioconductor.org        (R 4.0)              ✔                       ✔              (831ms)
#> BioCbooks     @ bioconductor.org        (R 4.0)              ✔                       ✔              (347ms)
#> BioCsoft      @ bioconductor.org        (R 4.1)              ✔                       ✔              (761ms)
#> BioCann       @ bioconductor.org        (R 4.1)              ✔                       ✔              (958ms)
#> BioCexp       @ bioconductor.org        (R 4.1)              ✔                       ✔              (981ms)
#> BioCworkflows @ bioconductor.org        (R 4.1)              ✔                       ✔              (997ms)
#> BioCbooks     @ bioconductor.org        (R 4.1)              ✔                       ✔              (329ms)