Skip to contents

Report DESCRIPTION file issues.

Source: R/issues_descriptions.R
issues_descriptions.Rd

Report issues with the DESCRIPTION files of packages.

Usage

issues_descriptions(meta = meta_packages())

Arguments

meta

A data frame with R-universe package check results returned by meta_checks().

Value

A named list of information about packages which do not comply with DESCRPTION checks. Each name is a package name, and each element contains specific information about non-compliance.

Details

issues_descriptions() scans downloaded metadata from the PACKAGES.json file of an R universe and scans for specific issues in a package's description file:

  1. The presence of a "Remotes" field.

  2. There is a security advisory at https://github.com/RConsortium/r-advisory-database for the given package version.

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.

See also

Other issues: issues_checks(), issues_dependencies(), issues_versions()

Examples

  meta <- meta_packages(repo = "https://wlandau.r-universe.dev")
  issues <- issues_descriptions(meta = meta)
  str(issues)
#> List of 2
#>  $ crew.aws.batch:List of 1
#>   ..$ remotes: chr "wlandau/crew"
#>  $ crew.cluster  :List of 1
#>   ..$ remotes: chr "wlandau/crew"