Skip to content

Latest commit

 

History

History
516 lines (395 loc) · 22.3 KB

README.md

File metadata and controls

516 lines (395 loc) · 22.3 KB
Raw

The R Installation Manager

Install, remove, configure R versions.

🚀  Features

  • Works on macOS, Windows and Linux.
  • Supports many Linux distributions, see list below.
  • Easy installation and update, no system requirements on any platform.
  • Install multiple R versions.
  • Select the default R version, for the terminal and RStudio.
  • Select R version to install using symbolic names: devel, next, release, oldrel, etc.
  • List R versions available to install.
  • Run multiple versions at the same time using quick links. E.g. R-4.1 or R-4.1.2 starts R 4.1.x. Quick links are automatically added to the user’s path.
  • On macOS it comes with a menu bar app that shows the default R version and lets to select it interactively. See below.
  • On arm64 macs select between x86_64 and arm64 versions or R, or install both.
  • Sets up the default CRAN mirror and PPM.
  • Installs pak and set up automatic system requirements installation.
  • Creates and configures user level package libraries.
  • Restricts permissions to the system library. (On macOS, not needed on Windows and Linux).
  • Includes auto-complete for zsh and bash, on macOS and Linux.
  • Updates R installations to allow debugging with lldb, and to allow core dumps, on macOS.
  • Installs the appropriate Rtools versions on Windows and sets them up.
  • Cleans up stale R-related entries from the Windows registry.
  • Switches to root/administrator user as needed.
  • Supports JSON output for scripting.

🐞  Known Issues

  • On macOS, R.app often does not work if you install multiple R versions.

Found another issue? Please report it in our issue tracker.

⬇️  Installing rig

Installing rig on macOS

You can one of our installers or our Homebrew tap.

Installing rig on macOS (installer)

Download the latest release from https://github.com/r-lib/rig/releases and install it the usual way.

Installing rig on macOS (Homebrew)

If you use Homebrew (Intel or Arm version), you can install rig from our tap:

brew tap r-lib/rig
brew install --cask rig

You can use x86_64 rig on Arm macs, and it will be able to install Arm builds of R. But you cannot use Arm rig on Intel macs. If you use both brew versions, only install rig with one of them.

To update rig you can run

brew upgrade --cask rig

Installing rig on Windows

There are several possible ways to install rig on Windows: with our installer, scoop, choco or winget.

Installing rig on Windows (installer)

Download the latest release from https://github.com/r-lib/rig/releases and install it the usual way.

rig adds itself to the user’s path, but you might need to restart your terminal after the installation on Windows.

Installing rig on Windows (Scoop)

If you use Scoop, you can install rig from the scoop bucket at cderv/r-bucket:

scoop bucket add r-bucket https://github.com/cderv/r-bucket.git
scoop install rig

To update run

scoop update rig

Installing rig on Windows (Chocolatey)

If you use Chocolatey (e.g. on GitHub Actions) you can install rig with

choco install rig

and upgrade to the latest version with

choco upgrade rig

Installing rig on Windows (WinGet)

An easy way to install rig on Windows 10 and above is to use the built-in WinGet package manager. The name of the package is posit.rig.

winget install posit.rig

Note that updating a WinGet package typically takes some time, so WinGet might not have the latest version of rig.

Installing rig on Linux

On Linux you can install rig from a DEB or RPM package, or from a tarball.

Supported Linux distributions

  • Debian 10, 11, 12,
  • Ubuntu 18.04, 20.04, 22.04,
  • Fedora Linux 37, 38, 39,
  • OpenSUSE 15.3, 15.4, 15.5,
  • SUSE Linux Enterprise 15 SP3, SP4, SP5,
  • CentOS 7,
  • Red Hat Enterprise Linux 7, 8, 9,
  • AlmaLinux 8, 9,
  • Rocky Linux 8, 9.

We use the R builds from the Posit R-builds project.

Installing rig on Ubuntu and Debian (DEB package)

On any Ubuntu or Debian distro, you can use our package repository to install rig. First you add our key to your config:

`which sudo` curl -L https://rig.r-pkg.org/deb/rig.gpg -o /etc/apt/trusted.gpg.d/rig.gpg

Then add the rig repository:

`which sudo` sh -c 'echo "deb http://rig.r-pkg.org/deb rig main" > /etc/apt/sources.list.d/rig.list'

If you already added both the key and the repository, then install the r-rig package (rig is a different package in Debian and Ubuntu):

`which sudo` apt update
`which sudo` apt install r-rig

Installing rig on RHEL, Fedora, CentOS, Rocky Linux, Almalinux, etc. (RPM package)

On most RPM based distros (except for OpenSUSE and SLES) you can install our RPM package directly:

`which sudo` yum install -y https://github.com/r-lib/rig/releases/download/latest/r-rig-latest-1.$(arch).rpm

Installing rig on OpenSUSE and SLES (RPM package)

On OpenSUSE and SLES use zypper instead of yum:

`which sudo` zypper install -y --allow-unsigned-rpm https://github.com/r-lib/rig/releases/download/latest/r-rig-latest-1.$(arch).rpm

Installing rig on any Linux distribution (tarball)

Download the latest releast from https://github.com/r-lib/rig/releases and uncompress it to /usr/local

curl -Ls https://github.com/r-lib/rig/releases/download/latest/rig-linux-$(arch)-latest.tar.gz |
  `which sudo` tar xz -C /usr/local

Installing auto-complete on macOS and Linux

The macOS and Linux installers also install completion files for zsh and bash.

zsh completions work out of the box.

For bash completions install the bash-completion package from Homebrew or your Linux distribution and make sure it is loaded from your .bashrc. (You don’t need to install bash from Homebrew, but you can if you like.)

⚙️  Usage

Use rig add to add a new R installation:

rig add release

Use rig list to list the currently installed R versions, and rig default to set the default one.

Run rig to see all commands and examples.

Run rig --help and rig <subcommand> --help to see the documentation.

Command list:

rig add        -- install a new R version [alias: install]
rig available  -- List R versions available to install.
rig default    -- print or set default R version [alias: switch]
rig library    -- manage package libraries [alias: lib] (experimental)
rig list       -- list installed R versions [alias: ls]
rig resolve    -- resolve a symbolic R version
rig rm         -- remove R versions [aliases: del, delete, remove]
rig rstudio    -- start RStudio with the specified R version
rig run        -- Run R, an R script or an R project
rig sysreqs    -- manage R-related system libraries and tools (experimental) (macOS)
rig system     -- manage current installations

Run rig <subcommand> --help for information about a subcommand.

macOS rig system subcommands

rig system add-pak                 -- install or update pak for an R version
rig system allow-debugger          -- allow debugging R with lldb and gdb
rig system allow-debugger-rstudio  -- allow debugging RStudio with lldb and gdb
rig system allow-core-dumps        -- allow creating core dumps when R crashes
rig system fix-permissions         -- restrict system library permissions to admin
rig system forget                  -- make system forget about R installations
rig system make-links              -- create R-* quick links
rig system make-orthogonal         -- make installed versions orthogonal
rig system no-openmp               -- remove OpenMP (-fopenmp) option for Apple compilers
rig system setup-user-lib          -- set up automatic user package libraries [alias: create-lib]

Windows rig system subcommands

rig system add-pak                 -- install or update pak for an R version
rig system clean-registry          -- clean stale R related entries in the registry
rig system make-links              -- create R-* quick links
rig system rtools                  -- manage Rtools installations
rig system setup-user-lib          -- set up automatic user package libraries [alias: create-lib]
rig system update-rtools40         -- update Rtools40 MSYS2 packages

Linux rig system subcommands

rig system detect-platform         -- detect operating system version and distribution
rig system add-pak                 -- install or update pak for an R version
rig system make-links              -- create R-* quick links
rig system setup-user-lib          -- set up automatic user package libraries [alias: create-lib]

⛵  macOS menu bar app

View and select the default R version in the macOS menu bar. Start RStudio or a recent RStudio project with the selected R version. Select between your package libraries.

To start the menu bar app the first time, run the Rig app in “Applications” from Finder or Spotlight, or run

open -a Rig

from a Terminal. Then you can check the “Launch at login” box in “Preferences” to start it automatically in the future.

Note: if you have a lot of menu bar apps running on an M1/M2 mac, then the some of them might be under the camera area. There is no good solution for this currently, other than running less menu bar apps.

📦  Docker containers with rig (and multiple R versions)

Use the ghcr.io/r-lib/rig/r Docker container to easily run multiple R versions. It is currently based on Ubuntu 22.04 and contains rig and the six latest R versions, including R-next and R-devel. It is available for x86_64 and arm64 systems:

> docker run ghcr.io/r-lib/rig/r rig ls
* name   version    aliases
------------------------------------------
  3.6.3
  4.0.5
  4.1.3
  4.2.3             oldrel
* 4.3.1             release
  devel  (R 4.4.0)
  next   (R 4.3.1)

See this image on GitHub.

All containers

We also have other containers with rig and either R-devel and R-release preinstalled, on various Linux distros. Here is a table of all containers:

Name OS R version Tags
ghcr.io/r-lib/rig/ubuntu-22.04-multi Ubuntu 22.04 last 6 (daily) r, rig, multi, ubuntu-multi
ghcr.io/r-lib/rig/ubuntu-22.04-release Ubuntu 22.04 release release, ubuntu, ubuntu-release, ubuntu-latest, ubuntu-latest-release, ubuntu-22.04
ghcr.io/r-lib/rig/ubuntu-22.04-devel Ubuntu 22.04 devel (daily) devel, ubuntu-devel, ubuntu-latest-devel
ghcr.io/r-lib/rig/ubuntu-20.04-release Ubuntu 20.04 release ubuntu-20.04
ghcr.io/r-lib/rig/ubuntu-20.04-devel Ubuntu 20.04 devel (daily)
ghcr.io/r-lib/rig/debian-12-release Debian 12 release debian, debian-release, debian-latest, debian-latest-release, debian-12
ghcr.io/r-lib/rig/debian-12-devel Debian 12 devel (daily) debian-devel, debian-latest-devel
ghcr.io/r-lib/rig/debian-11-release Debian 11 release debian-11
ghcr.io/r-lib/rig/debian-11-devel Debian 11 devel (daily)
ghcr.io/r-lib/rig/debian-10-release Debian 10 release debian-10
ghcr.io/r-lib/rig/debian-10-devel Debian 10 devel (daily)
ghcr.io/r-lib/rig/fedora-39-release Fedora 39 release fedora, fedora-release, fedora-latest, fedora-latest-release, fedora-39
ghcr.io/r-lib/rig/fedora-39-devel Fedora 39 devel fedora-devel, fedora-latest-devel
ghcr.io/r-lib/rig/fedora-38-release Fedora 38 release fedora-38
ghcr.io/r-lib/rig/fedora-38-devel Fedora 38 devel
ghcr.io/r-lib/rig/opensuse-15.5-release OpenSUSE Leap 15.5 release opensuse, opensuse-release, opensuse-latest, opensuse-latest-release, opensuse-15.5
ghcr.io/r-lib/rig/opensuse-15.5-devel OpenSUSE Leap 15.5 devel (daily) opensuse-devel, opensuse-latest-devel
ghcr.io/r-lib/rig/opensuse-15.4-release OpenSUSE Leap 15.4 release opensuse-15.4
ghcr.io/r-lib/rig/opensuse-15.4-devel OpenSUSE Leap 15.4 devel (daily)

For convenience, we also create these tags:

Tag Image Description
ghcr.io/r-lib/rig/r ubuntu-22.04-multi Last 6 R versions on latest Ubuntu.
ghcr.io/r-lib/rig/rig ” ”
ghcr.io/r-lib/rig/multi ” ”
ghcr.io/r-lib/rig/ubuntu-multi ” ”
ghcr.io/r-lib/rig/release ubuntu-22.04-release Latest R release.
ghcr.io/r-lib/rig/ubuntu ubuntu-22.04-release Latest R release on latest Ubuntu.
ghcr.io/r-lib/rig/ubuntu-22.04 ubuntu-22.04-release Latest R release on Ubuntu 22.04.
ghcr.io/r-lib/rig/devel ubuntu-22.04-devel R devel.
ghcr.io/r-lib/rig/ubuntu-devel ubuntu-22.04-devel R devel on latest Ubuntu.
ghcr.io/r-lib/rig/ubuntu-20.04 ubuntu-20.04-release Latest R release on Ubuntu 20.04.
ghcr.io/r-lib/rig/debian debian-12-release Latest R release on latest Debian.
ghcr.io/r-lib/rig/debian-12 debian-12-release Latest R release on Debian 12.
ghcr.io/r-lib/rig/debian-devel debian-12-devel R devel on latest Debian.
ghcr.io/r-lib/rig/debian-11 debian-11-release Latest R release on Debian 11.
ghcr.io/r-lib/rig/debian-10 debian-10-release Latest R release on Debian 10.
ghcr.io/r-lib/rig/fedora fedora-39-release Latest R release on latest Fedora.
ghcr.io/r-lib/rig/fedora-39 fedora-39-release Latest R release on Fedora 39.
ghcr.io/r-lib/rig/fedora-devel fedora-39-devel R devel on latest Fedora.
ghcr.io/r-lib/rig/fedora-38 fedora-38-release Latest R release on Fedora 38.
ghcr.io/r-lib/rig/opensuse opensuse-15.5-release Latest R release on latest OpenSUSE.
ghcr.io/r-lib/rig/opensuse-15.5 opensuse-15.5-release Latest R release on OpenSUSE 15.5.
ghcr.io/r-lib/rig/opensuse-devel opensuse-15.5-devel R devel on latest OpenSUSE.
ghcr.io/r-lib/rig/opensuse-15.4 opensuse-15.4-release Latest R release on OpenSUSE 15.4.

See all container images on GitHub.

Docker container features:

For all containers:

  • rig is pre-installed, so you can easily add or remove R versions.
  • https://github.com/r-lib/pak is installed for all R versions.
  • Automatic system dependency installation via pak.
  • Linux binary packages are automatically installed from the Posit Public Package Manager in x86_64 containers, on Ubuntu, Debian and OpenSUSE.
  • Available on x86_64 and aarch64.

🤝  Feedback

Please open an issue in our issue tracker at https://github.com/r-lib/rig/issues

❓  FAQ

Why does rig create a user package library?

Installing non-base packages into a user package library has several benefits:

  • The system library is not writeable for regular users on some systems (Windows and Linux, typically), so we might as well create a properly versioned user library at the default place.
  • Some tools need a clean R environment, with base packages only, and do not work well if user packages are installed into the system library. E.g. R CMD check is such a tool, and https://github.com/r-lib/revdepcheck is another.
  • You can delete an R installation (e.g. with rig rm) and then and then install it again, without losing your R packages.
Why does rig install pak?

To be able to install R packages efficiently, from CRAN, Bioconductor or GitHub, right from the start. pak also supports installing system libraries automatically on some Linux systems.

If you don’t want rig add to install pak, use the --without-pak option.

Why does rig change the permissions of the system library (on macOS)?

To make sure that you don’t install packages accidentally into the system library. See “Why does rig create a user package library?” above.

Why does rig set the default CRAN mirror?

To avoid the extra work the users need to spend on this.

The https://cloud.r-project.org mirror is usually better than the other, in that it is a CDN that is close to most users, and that it is updated more often.

If you want to use a different mirror, you can set the repos option in your .Rprofile, so the rig repo settings will be ignored.

You can also use the --without-cran-mirror option of rig add.

Why does rig set up P3M?

P3M (Posit Public Package Manager) is generally superior to a regular CRAN mirror on Windows and many Linux systems.

On Linux it includes binary packages for many popular distributions.

On Windows, it includes up to date binary packages for older R versions as well.

To avoid P3M use the --without-p3m option (or the legacy --without-rspm) option of rig add.

Can rig install R without admin permissions

No, currently it cannot.

How is rig different from RSwitch?

While there is a small overlap in functionality, rig and RSwitch are very different. I suggest you look over the features of both to decide which one suits your needs better.

If you like rig and also like the extra features of RSwitch, then you can use them together just fine: changing the default R version in RSwitch also changes it in rig and vice versa. You can use the rig cli and the RSwitch app together, or you can also use both menu bar apps at the same time.

📘   License

MIT 2021-2024 © Posit Software, PBC.