sysreqs | R Documentation |
Compute the system requirements (system libraries; operating system packages) required by a set of R packages.
sysreqs(
packages = NULL,
...,
local = FALSE,
check = NULL,
report = TRUE,
distro = NULL,
collapse = FALSE,
project = NULL
)
packages |
A vector of R package names. When |
... |
Unused arguments, reserved for future expansion. If any arguments
are matched to |
local |
Boolean; should |
check |
Boolean; should |
report |
Boolean; should |
distro |
The name of the Linux distribution for which system requirements should be checked – typical values are "ubuntu", "debian", and "redhat". These should match the distribution names used by the R system requirements database. A version suffix can be included; for example, "ubuntu:24.04". |
collapse |
Boolean; when reporting which packages need to be installed,
should the report be collapsed into a single installation command? When
|
project |
The project directory. If |
This function relies on the database of package system requirements
maintained by Posit at https://github.com/rstudio/r-system-requirements,
as well as the "meta-CRAN" service at https://crandb.r-pkg.org. This
service primarily exists to map the (free-form) SystemRequirements
field
used by R packages to the system packages made available by a particular
operating system.
As an example, the curl
R package depends on the libcurl
system library,
and declares this with a SystemRequirements
field of the form:
libcurl (>= 7.62): libcurl-devel (rpm) or libcurl4-openssl-dev (deb)
This dependency can be satisfied with the following command line invocations on different systems:
Debian: sudo apt install libcurl4-openssl-dev
Redhat: sudo dnf install libcurl-devel
and so sysreqs("curl")
would help provide the name of the package
whose installation would satisfy the libcurl
dependency.
## Not run:
# report the required system packages for this system
sysreqs()
# report the required system packages for a specific OS
sysreqs(platform = "ubuntu")
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.