Skip to contents

Record package issues.

Source: R/record_issues.R
record_issues.Rd

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

Usage

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

Arguments

repo

Character of length 1, URL of the package repository. R-multiverse uses "https://community.r-multiverse.org".

versions

Character of length 1, file path to a JSON manifest tracking the history of released versions of packages.

output

Character of length 1, file path to the JSON file to record new package issues. Each call to record_issues() overwrites the contents of the file.

mock

For testing purposes only, a named list of data frames for inputs to various intermediate functions.

verbose

TRUE to print progress while checking issues with dependencies, FALSE otherwise.

Value

NULL (invisibly).

Package issues

Functions like issues_versions() and issues_descriptions() 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_issues() gathers together all the issues about R-multiverse packages.

Issue data

For each package with observed problems, record_issues() writes a JSON list entry in the output JSON file with one element for each type of failing check. Each check-specific element has an informative name (for example, checks, descriptions, or versions) and a list of diagnostic information. In addition, there is a date field to indicate when an issue was first detected. The date automatically resets the next time all the issues in the package are resolved.

Examples

  repo <- "https://wlandau.r-universe.dev"
  output <- tempfile()
  versions <- tempfile()
  record_versions(
    versions = versions,
    repo = repo
  )
  record_issues(
    repo = repo,
    versions = versions,
    output = output
  )
  writeLines(readLines(output))
#> []