Package 'multiverse.internals'

Description

Filter the PACKAGES and PACKAGES.gz files to only list certain packages.

Usage

filter_meta(path_meta, path_staging)

Arguments

See Also

Other staging: freeze_dependencies(), rclone_includes(), stage_candidates()

Examples

## Not run: 
path_meta <- tempfile()
dir.create(path_meta)
mock <- system.file(
  file.path("mock", "meta"),
  package = "multiverse.internals",
  mustWork = TRUE
)
file.copy(mock, path_meta, recursive = TRUE)
path_staging <- tempfile()
url_staging <- "https://github.com/r-multiverse/staging"
gert::git_clone(url = url_staging, path = path_staging)
filter_meta(path_meta, path_staging)

## End(Not run)

Description

Freeze the targeted versions of base R and CRAN packages.

Usage

freeze_dependencies(path_staging, path_community)

Arguments

Details

freeze_dependencies() runs during the month-long dependency freeze phase of Staging in which base R and CRAN packages are locked in the Staging universe until after the next Production snapshot. This establishes checks in the Staging universe using the exact set of dependencies that will be used in the candidate freeze (see stage_candidates()).

freeze_dependencies() copies the Community repository packages.json into the Staging repository to reset the Staging process. It also writes a config.json file with the date of the targeted CRAN snapshot.

Value

NULL (invisibly)

See Also

Other staging: filter_meta(), rclone_includes(), stage_candidates()

Examples

## Not run: 
url_staging = "https://github.com/r-multiverse/staging"
url_community = "https://github.com/r-multiverse/community"
path_staging <- tempfile()
path_community <- tempfile()
gert::git_clone(url = url_staging, path = path_staging)
gert::git_clone(url = url_community, path = path_community)
freeze_dependencies(
  path_staging = path_staging,
  path_community = path_community
)

## End(Not run)

Description

Summarize the status of a package in human-readable text.

Usage

interpret_status(package, status)

Arguments

Value

A character string summarizing the status of a package in prose.

See Also

Other status: update_status()

Description

Report packages whose current versions have advisories in the R Consortium Advisory Database: https://github.com/RConsortium/r-advisory-database

Usage

issues_advisories(meta = meta_packages())

Arguments

Value

A data frame with one row for each problematic package and columns with details.

See Also

Other issues: issues_dependencies(), issues_licenses(), issues_r_cmd_check(), issues_remotes(), issues_version_conflicts(), issues_versions()

Examples

## Not run: 
issues_advisories()

## End(Not run)

Description

Flag packages which have issues in their strong dependencies (⁠Imports:⁠, ⁠Depends:⁠, and ⁠LinkingTo:⁠ in the DESCRIPTION.) These include indirect/upstream dependencies, as well, not just the explicit mentions in the DESCRIPTION file.

Usage

issues_dependencies(packages, meta = meta_packages(), verbose = FALSE)

Arguments

Value

A data frame with one row for each package impacted by upstream dependencies. Each element of the dependencies column is a nested list describing the problems upstream.

To illustrate the structure of this list, suppose Package tarchetypes depends on package targets, and packages jagstargets and stantargets depend on tarchetypes. In addition, package targets has a problem in ⁠R CMD check⁠ which might cause problems in tarchetypes and packages downstream.

status_dependencies() represents this information in the following list:

list(
  jagstargets = list(targets = "tarchetypes"),
  tarchetypes = list(targets = character(0)),
  stantargets = list(targets = "tarchetypes")
)

In general, the returned list is of the form:

list(
  impacted_reverse_dependency = list(
    upstream_culprit = c("direct_dependency_1", "direct_dependency_2")
  )
)

where upstream_culprit causes problems in impacted_reverse_dependency through direct dependencies direct_dependency_1 and direct_dependency_2.

See Also

Other issues: issues_advisories(), issues_licenses(), issues_r_cmd_check(), issues_remotes(), issues_version_conflicts(), issues_versions()

Examples

## Not run: 
issues_dependencies(packages = "targets")

## End(Not run)

Description

Report packages without standard free and open-source licenses.

Usage

issues_licenses(meta = meta_packages())

Arguments

See Also

Other issues: issues_advisories(), issues_dependencies(), issues_r_cmd_check(), issues_remotes(), issues_version_conflicts(), issues_versions()

Examples

## Not run: 
issues_licenses()

## End(Not run)

Description

Report issues from ⁠R CMD check⁠ on R-universe.

Usage

issues_r_cmd_check(meta = meta_packages())

Arguments

Details

issues_r_cmd_check() reads output from the R-universe ⁠R CMD check⁠ results API to scan all R-multiverse packages for status that may have happened during building and testing.

Value

A data frame with one row for each problematic package and columns for the package names and ⁠R CMD check⁠ issues.

Package status

Functions like issues_versions() and issues_r_cmd_check() perform health checks for all packages in R-multiverse. For a complete list of checks, see the ⁠issues_*()⁠ functions listed at https://r-multiverse.org/multiverse.internals/reference/index.html. record_versions() updates the version number history of releases in R-multiverse, and record_status() gathers together all the status about R-multiverse packages.

See Also

Other issues: issues_advisories(), issues_dependencies(), issues_licenses(), issues_remotes(), issues_version_conflicts(), issues_versions()

Examples

## Not run: 
issues_r_cmd_check()

## End(Not run)

Description

Report packages with ⁠Remotes:⁠ fields in the DESCRIPTION file.

Usage

issues_remotes(meta = meta_packages())

Arguments

See Also

Other issues: issues_advisories(), issues_dependencies(), issues_licenses(), issues_r_cmd_check(), issues_version_conflicts(), issues_versions()

Examples

## Not run: 
issues_remotes()

## End(Not run)

Description

Report packages with higher versions in different repositories. A higher version in a different repository could cause that repository to override R-multiverse in install.packages().

Usage

issues_version_conflicts(meta = meta_packages(), repo = "cran")

Arguments

Value

A data frame with one row for each problematic package and columns with details.

See Also

Other issues: issues_advisories(), issues_dependencies(), issues_licenses(), issues_r_cmd_check(), issues_remotes(), issues_versions()

Examples

## Not run: 
issues_version_conflicts()

## End(Not run)

Description

Check package version number history for compliance.

Usage

issues_versions(versions)

Arguments

Details

This function checks the version number history of packages in R-multiverse and reports any packages with issues. The current released version of a given package must be unique, and it must be greater than all the versions of all the previous package releases.

Value

A data frame with one row for each problematic package and columns with the package names and version issues.

See Also

Other issues: issues_advisories(), issues_dependencies(), issues_licenses(), issues_r_cmd_check(), issues_remotes(), issues_version_conflicts()

Examples

lines <- c(
    "[",
    " {",
    " \"package\": \"package_unmodified\",",
    " \"version_current\": \"1.0.0\",",
    " \"hash_current\": \"hash_1.0.0\",",
    " \"version_highest\": \"1.0.0\",",
    " \"hash_highest\": \"hash_1.0.0\"",
    " },",
    " {",
    " \"package\": \"version_decremented\",",
    " \"version_current\": \"0.0.1\",",
    " \"hash_current\": \"hash_0.0.1\",",
    " \"version_highest\": \"1.0.0\",",
    " \"hash_highest\": \"hash_1.0.0\"",
    " },",
    " {",
    " \"package\": \"version_incremented\",",
    " \"version_current\": \"2.0.0\",",
    " \"hash_current\": \"hash_2.0.0\",",
    " \"version_highest\": \"2.0.0\",",
    " \"hash_highest\": \"hash_2.0.0\"",
    " },",
    " {",
    " \"package\": \"version_unmodified\",",
    " \"version_current\": \"1.0.0\",",
    " \"hash_current\": \"hash_1.0.0-modified\",",
    " \"version_highest\": \"1.0.0\",",
    " \"hash_highest\": \"hash_1.0.0\"",
    " }",
    "]"
  )
  versions <- tempfile()
  writeLines(lines, versions)
  out <- issues_versions(versions)
  str(out)

Description

List package metadata in an R universe.

Usage

meta_packages(repo = "https://community.r-multiverse.org")

Arguments

Value

A data frame with one row per package and columns with package metadata.

See Also

Other meta: meta_snapshot()

Examples

## Not run: 
meta_packages()

## End(Not run)

Description

Show the metadata for the current targeted Production snapshot.

Usage

meta_snapshot(today = Sys.Date())

Arguments

Value

A data frame with one row and columns with metadata about the targeted snapshot.

See Also

Other meta: meta_packages()

Examples

meta_snapshot(today = Sys.Date())

Description

Write text files to pass to the --include-from flag in Rclone when uploading snapshots.

Usage

rclone_includes(path_staging)

Arguments

See Also

Other staging: filter_meta(), freeze_dependencies(), stage_candidates()

Examples

## Not run: 
url_staging = "https://github.com/r-multiverse/staging"
path_staging <- tempfile()
path_community <- tempfile()
gert::git_clone(url = url_staging, path = path_staging)
stage_candidates(path_staging = path_staging)
rclone_includes(path_staging)

## End(Not run)

Description

R-multiverse packages must have valid free and open-source (FOSS) licenses to protect the intellectual property rights of the package owners (c.f. https://en.wikipedia.org/wiki/Free_and_open-source_software). record_nonstandard_licenses() records packages with nonstandard licenses.

Usage

record_nonstandard_licenses(
  repo = "https://community.r-multiverse.org",
  path = "nonstandard_licenses.json"
)

Arguments

Value

NULL (invisibly). Called for its side effects.

Description

Record R-multiverse package status in package-specific JSON files.

Usage

record_status(
  repo = "https://community.r-multiverse.org",
  versions = "versions.json",
  output = "status.json",
  mock = NULL,
  verbose = FALSE
)

Arguments

Value

NULL (invisibly).

Package status

Functions like issues_versions() and issues_r_cmd_check() perform health checks for all packages in R-multiverse. For a complete list of checks, see the ⁠issues_*()⁠ functions listed at https://r-multiverse.org/multiverse.internals/reference/index.html. record_versions() updates the version number history of releases in R-multiverse, and record_status() gathers together all the status about R-multiverse packages.

Examples

## Not run: 
output <- tempfile()
versions <- tempfile()
record_versions(
  versions = versions,
  repo = repo
)
record_status(
  repo = repo,
  versions = versions,
  output = output
)
writeLines(readLines(output))

## End(Not run)

Description

Record the manifest of versions of packages and their hashes.

Usage

record_versions(
  versions = "versions.json",
  repo = "https://community.r-multiverse.org",
  current = multiverse.internals::get_current_versions(repo = repo)
)

Arguments

Details

This function tracks a manifest containing the current version, the current hash, the highest version ever released, and the hash of the highest version ever released. issues_versions() uses this information to determine whether the package complies with best practices for version numbers.

Value

NULL (invisibly). Writes version information to a JSON file.

Package status

Functions like issues_versions() and issues_r_cmd_check() perform health checks for all packages in R-multiverse. For a complete list of checks, see the ⁠issues_*()⁠ functions listed at https://r-multiverse.org/multiverse.internals/reference/index.html. record_versions() updates the version number history of releases in R-multiverse, and record_status() gathers together all the status about R-multiverse packages.

Examples

## Not run: 
output <- tempfile()
versions <- tempfile()
# First snapshot:
record_versions(
  versions = versions,
  repo = repo
)
readLines(versions)
# In subsequent snapshots, we have historical information about versions.
record_versions(
  versions = versions,
  repo = repo
)
readLines(versions)

## End(Not run)

Description

Review a pull request to add packages to R-multiverse.

Usage

review_pull_request(
  owner = "r-multiverse",
  repo = "contributions",
  number,
  advisories = character(0L),
  organizations = character(0L)
)

Arguments

Value

NULL (invisibly).

See Also

Other pull request reviews: review_pull_requests()

Description

Review pull requests which add packages to packages.json.

Usage

review_pull_requests(owner = "r-multiverse", repo = "contributions")

Arguments

Value

NULL (invisibly).

See Also

Other pull request reviews: review_pull_request()

Description

Stage release candidates for the targeted Production snapshot.

Usage

stage_candidates(path_staging)

Arguments

Details

stage_candidates() implements the candidate freeze during the month-long period prior to the Production snapshot. Packages that pass R-multiverse checks are frozen (not allowed to update further) and staged for Production. Packages with at least one failing not staged for Production, and maintainers can update them with new GitHub/GitLab releases.

stage_candidates() writes packages.json to control contents of the Staging universe.

Value

NULL (invisibly)

See Also

Other staging: filter_meta(), freeze_dependencies(), rclone_includes()

Examples

## Not run: 
url_staging <- "https://github.com/r-multiverse/staging"
path_staging <- tempfile()
gert::git_clone(url = url_staging, path = path_staging)
stage_candidates(path_staging = path_staging)

## End(Not run)

Description

Update the repository which reports the status on individual packages.

Usage

update_status(path_status, path_staging, path_community)

Arguments

See Also

Other status: interpret_status()

Examples

## Not run: 
url_staging = "https://github.com/r-multiverse/staging"
url_community = "https://github.com/r-multiverse/community"
path_status <- tempfile()
path_staging <- tempfile()
path_community <- tempfile()
gert::git_clone(url = url_staging, path = path_staging)
gert::git_clone(url = url_community, path = path_community)
update_status(
  path_status = path_status,
  path_staging = path_staging,
  path_community = path_community
)
writeLines(
  readLines(
    file.path(path_status, "community", "multiverse.internals.html")
  )
)
writeLines(
  readLines(
    file.path(path_status, "community", "multiverse.internals.xml")
  )
)

## End(Not run)

Description

Update the list of packages for each R-multiverse topic.

Usage

update_topics(path, repo = "https://community.r-multiverse.org", mock = NULL)

Arguments

Value

NULL (invisibly). Called for its side effects.

Examples

## Not run: 
path <- tempfile()
gert::git_clone("https://github.com/r-multiverse/topics", path = path)
update_topics(path = path, repo = "https://community.r-multiverse.org")

## End(Not run)