Home

Awesome

This repository is now archived in favor of https://github.com/rstudio/r-system-requirements

sysreqs

SystemRequirements for R packages

Superseded!

This project is replaced by a new database rstudio/r-system-requirements, which is used by pak and rhub2.

Introduction

Many R packages require system libraries or other external software to build or run. The SystemRequirements field in the package DESCRIPTION file should declare these dependencies, as free form text. This makes it difficult to automate building and checking of R packages, since we need to guess which software should be installed on the build machine.

The sysreqs project formalizes these requirements, and provides a database with API to quickly find out which Homebrew, Debian, Ubuntu, RHEL/Centos, etc packages or other software needs to be available to build and use R packages.

In this README:

Supported platforms

Distributions using deb package format:

Distributions using rpm package format:

Distributions using the PKGBUILD package format:

Non-native package formats:

Database format

The sysreqs database is a JSON document store. Each document contains mappings for a single canonical system requirement. It contains both the mappings to SystemRequirements fields, and platform dependent packages or URLs.

Below an example to make this clear. Several R packages require the libxml2 library. For building these packages from source, the libxml2 development headers are needed as well. The R packages refer to libxml2 in different ways. E.g. igraph has simply libxml2 and XML has libxml2 (>= 2.6.3) in their SystemRequirements fields.

{
  "libxml2": {
    "sysreqs": "libxml2",
    "platforms": {
       "DEB": "libxml2-dev",
       "OSX/brew": null,
       "RPM": "libxml2-devel"
    }
  }
}

Some notes:

Database access

See API docs at https://sysreqs.r-hub.io/

Contributing

Your contributions are welcome! More details below.

Adding or completing entries

Please read about the data format first. Entries should be added or improved via pull requests.

Reporting your use case

If you maintain a public platform/tool using sysreqsdb, make a PR to this repo updating the section below. Please put your tool at the very end of the list.

Use cases of the database

License

MIT © The R Consortium