• Stars
    star
    460
  • Rank 89,828 (Top 2 %)
  • Language
    Rust
  • License
    MIT License
  • Created over 2 years ago
  • Updated 5 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

The R Installation Manager

The R Installation Manager

Install, remove, configure R versions.

🚀  Features

  • Works on macOS, Windows and Linux (Ubuntu LTS and Debian, x86_64 and aarch64).
  • 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.
  • 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 M1 macs select between x86_64 and arm64 versions or R, or install both.
  • 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.

🐞  Known Issues

  • On macOS, R.app often does not work if you install multiple R versions.
  • On Windows you need to restart your shell or terminal after installing Rtools, for the changes to take effect.
  • On Windows, rig rstudio changes the R version in the registry temporarily before starting RStudio and then changes it back after a short wait. If RStudio starts up very slowly, then the wait might be too short, and it might start up with the wrong R version.
  • On Windows Rtools installation will fail if the same version of Rtools is already installed.

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

⬇️  Installation

macOS (installer)

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

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

Windows (WinGet)

The simplest 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

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.

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

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

Note that a new rig version might take a week or two to publish on Chocolatey, so the installer and the version in Scoop might be newer.

Linux

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-latest.tar.gz |
  sudo tar xz -C /usr/local

If you are running Linux on arm64, download the arm64 build:

curl -Ls https://github.com/r-lib/rig/releases/download/latest/rig-linux-arm64-latest.tar.gz |
  sudo tar xz -C /usr/local

Supported Linux distributions:

  • Ubuntu LTS from r-builds, currently 18.04, 20.04, 22.04.
  • Debian from r-builds, currently 9, 10 and 11.

Other Linux distributions are coming soon.

Auto-complete

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.

Command list:

rig add        -- install a new R version [alias: 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 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 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 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 container with rig (and multiple R versions)

Use the rhub/rig (also at 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.5.3
  3.6.3
  4.0.5
  4.1.3             oldrel
* 4.2.2             release
  devel  (R 4.3.0)
  next   (R 4.2.2)

Docker container features:

See this image on Docker Hub or GitHub.

🤝  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-2023 © Posit Software, PBC.

More Repositories

1

devtools

Tools to make an R developer's life easier
R
2,336
star
2

lintr

Static Code Analysis for R
R
1,135
star
3

httr

httr: a friendly http package for R
R
975
star
4

actions

GitHub Actions for the R community
JavaScript
868
star
5

testthat

An R 📦 to make testing 😀
R
849
star
6

usethis

Set up commonly used 📦 components
R
798
star
7

pkgdown

Generate static html documentation for an R package
R
686
star
8

styler

Non-invasive pretty printing of R code
R
657
star
9

pak

A fresh approach to package installation
C
575
star
10

cli

Tools for making beautiful & useful command line interfaces
R
571
star
11

roxygen2

Generate R package documentation from inline R comments
R
554
star
12

rlang

Low-level API for programming with R
R
454
star
13

progress

Progress bar in your R terminal
R
447
star
14

R6

Encapsulated object-oriented programming for R
R
393
star
15

here

A simpler way to find your files
R
387
star
16

scales

Tools for ggplot2 scales
R
373
star
17

fs

Provide cross platform file operations based on libuv.
C
353
star
18

covr

Test coverage reports for R
R
328
star
19

rex

Friendly regular expressions for R.
R
325
star
20

crayon

🖍️ R package for colored terminal output — now superseded by cli
R
321
star
21

memoise

Easy memoisation for R
R
310
star
22

remotes

Install R packages from GitHub, GitLab, Bitbucket, git, svn repositories, URLs
R
309
star
23

lobstr

Understanding complex R objects with tools similar to str()
R
294
star
24

callr

Call R from R
R
281
star
25

vctrs

Generic programming with typed R vectors
C
272
star
26

waldo

Find differences between R objects
R
272
star
27

slider

Sliding Window Functions
R
267
star
28

zeallot

Variable assignment with zeal! (or multiple, unpacking, and destructuring assignment in R)
R
245
star
29

conflicted

An alternative conflict resolution strategy for R
R
242
star
30

bench

High Precision Timing of R Expressions
R
237
star
31

gmailr

Access the Gmail RESTful API from R.
R
234
star
32

processx

Execute and Control Subprocesses from R
R
225
star
33

xml2

Bindings to libxml2
R
212
star
34

asciicast

Turn R scripts into terminal screencasts
R
211
star
35

gh

Minimalistic GitHub API client in R
R
210
star
36

httr2

Make HTTP requests and process their responses. A modern reimagining of httr.
R
206
star
37

cpp11

cpp11 helps you to interact with R objects using C++ code.
C++
187
star
38

keyring

🔐 Access the system credential store from R
R
185
star
39

vdiffr

Visual regression testing and graphical diffing with testthat
C++
177
star
40

svglite

A lightweight svg graphics device for R
C++
177
star
41

pillar

Format columns with colour
R
173
star
42

ragg

Graphic Devices Based on AGG
C++
169
star
43

ymlthis

write YAML for R Markdown, bookdown, blogdown, and more
R
163
star
44

hugodown

Make websites with hugo and RMarkdown
R
163
star
45

withr

Methods For Temporarily Modifying Global State
R
162
star
46

coro

Coroutines for R
R
146
star
47

rprojroot

Finding files in project subdirectories
R
146
star
48

debugme

Easy and efficient debugging for R packages
R
144
star
49

available

Check if a package name is available to use
R
141
star
50

ellipsis

Tools for Working with ...
R
138
star
51

archive

R bindings to libarchive, supporting a large variety of archive formats
C++
138
star
52

gert

Simple git client for R
C
136
star
53

later

Schedule an R function or formula to run after a specified period of time.
C++
132
star
54

rray

Simple Arrays
R
130
star
55

isoband

isoband: An R package to generate contour lines and polygons.
C++
130
star
56

fastmap

Fast map implementation for R
C++
128
star
57

prettyunits

Pretty, human readable formatting of quantities
JavaScript
126
star
58

tidyselect

A backend for functions taking tidyverse selections
R
122
star
59

desc

Manipulate DESCRIPTION files
R
120
star
60

gargle

Infrastructure for calling Google APIs from R, including auth
R
112
star
61

rcmdcheck

Run R CMD check from R and collect the results
R
110
star
62

evaluate

A version of eval for R that returns more information about what happened
R
107
star
63

prettycode

Syntax highlight R code in the terminal
R
100
star
64

mockery

A mocking library for R.
R
100
star
65

sloop

S language OOP ⛵️
R
98
star
66

pkgdepends

R Package Dependency Resolution
R
93
star
67

revdepcheck

R package reverse dependency checking
R
93
star
68

clock

A Date-Time Library for R
R
93
star
69

lifecycle

Manage the life cycle of your exported functions and arguments
R
91
star
70

systemfonts

System Native Font Handling in R
C++
90
star
71

gtable

The layout packages that powers ggplot2
R
85
star
72

askpass

Password Entry for R, Git, and SSH
R
83
star
73

rappdirs

Find OS-specific directories to store data, caches, and logs. A port of python's AppDirs
R
81
star
74

zip

Platform independent zip compression via miniz
C
81
star
75

commonmark

High Performance CommonMark and Github Markdown Rendering in R
C
81
star
76

downlit

Syntax Highlighting and Automatic Linking
R
80
star
77

clisymbols

Unicode symbols for CLI applications, with fallbacks
R
74
star
78

tree-sitter-r

C
74
star
79

ps

R package to query, list, manipulate system processes
C
72
star
80

sessioninfo

Print Session Information
R
72
star
81

pkgapi

Create a map of functions for an R package - WORK IN PROGRESS!
R
69
star
82

credentials

Tools for Managing SSH and Git Credentials
R
69
star
83

roxygen2md

Convert elements of roxygen documentation to markdown
R
69
star
84

sodium

R bindings to libsodium
R
68
star
85

backports

Reimplementations of Functions Introduced Since R-3.0.0
R
65
star
86

pkgbuild

Find tools needed to build R packages
R
65
star
87

cliapp

Rich Command Line Applications
R
62
star
88

webfakes

Fake web apps for HTTP testing R packages
C
61
star
89

generics

Common generic methods
R
60
star
90

diffviewer

HTML widget to visually compare files
JavaScript
57
star
91

liteq

Serverless R message queue using SQLite
R
55
star
92

pkgload

Simulate installing and loading a package
R
55
star
93

cachem

Key-value caches for R
R
53
star
94

carrier

Create standalone functions for remote execution
R
49
star
95

brio

Basic R Input Output
R
49
star
96

jose

Javascript Object Signing and Encryption for R
R
47
star
97

urlchecker

Run CRAN URL checks from older versions of R
R
46
star
98

pkgconfig

Private configuration for R packages
R
40
star
99

filelock

Cross platform file locking in R
R
39
star
100

pkginstall

Provides a replacement for `utils::install.packages()`
R
35
star