File: system_requirements.Rd

package info (click to toggle)
r-cran-remotes 2.5.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,000 kB
  • sloc: sh: 14; makefile: 2
file content (36 lines) | stat: -rw-r--r-- 1,207 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/system_requirements.R
\name{system_requirements}
\alias{system_requirements}
\title{Query the system requirements for a package (and its dependencies)}
\usage{
system_requirements(
  os,
  os_release = NULL,
  path = ".",
  package = NULL,
  curl = Sys.which("curl")
)
}
\arguments{
\item{os, os_release}{The operating system and operating system release version, see
\url{https://github.com/rstudio/r-system-requirements#operating-systems} for the
list of supported operating systems.

If \code{os_release} is \code{NULL}, \code{os} must consist of the operating system
and the version separated by a dash, e.g. \code{"ubuntu-18.04"}.}

\item{path}{The path to the dev package's root directory.}

\item{package}{CRAN package name(s) to lookup system requirements for. If not
\code{NULL}, this is used and \code{path} is ignored.}

\item{curl}{The location of the curl binary on your system.}
}
\value{
A character vector of commands needed to install the system requirements for the package.
}
\description{
Returns a character vector of commands to run that will install system
requirements for the queried operating system.
}