• Stars
    star
    609
  • Rank 73,614 (Top 2 %)
  • Language
    Rust
  • License
    MIT License
  • Created about 3 years ago
  • Updated 4 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,392
star
2

lintr

Static Code Analysis for R
R
1,193
star
3

httr

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

actions

GitHub Actions for the R community
TypeScript
948
star
5

testthat

An R ๐Ÿ“ฆ to make testing ๐Ÿ˜€
R
875
star
6

usethis

Set up commonly used ๐Ÿ“ฆ components
R
842
star
7

pkgdown

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

styler

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

pak

A fresh approach to package installation
C
652
star
10

cli

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

roxygen2

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

rlang

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

progress

Progress bar in your R terminal
R
463
star
14

here

A simpler way to find your files
R
410
star
15

R6

Encapsulated object-oriented programming for R
R
405
star
16

scales

Tools for ggplot2 scales
R
392
star
17

fs

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

rex

Friendly regular expressions for R.
R
331
star
19

covr

Test coverage reports for R
R
331
star
20

crayon

๐Ÿ–๏ธ R package for colored terminal output โ€” now superseded by cli
R
325
star
21

remotes

Install R packages from GitHub, GitLab, Bitbucket, git, svn repositories, URLs
R
325
star
22

memoise

Easy memoisation for R
R
315
star
23

lobstr

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

profvis

Visualize R profiling data
JavaScript
297
star
25

callr

Call R from R
R
295
star
26

slider

Sliding Window Functions
R
295
star
27

vctrs

Generic programming with typed R vectors
C
284
star
28

waldo

Find differences between R objects
R
275
star
29

zeallot

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

conflicted

An alternative conflict resolution strategy for R
R
244
star
31

bench

High Precision Timing of R Expressions
R
241
star
32

httr2

Make HTTP requests and process their responses. A modern reimagining of httr.
R
232
star
33

gmailr

Access the Gmail RESTful API from R.
R
229
star
34

processx

Execute and Control Subprocesses from R
R
229
star
35

asciicast

Turn R scripts into terminal screencasts
R
224
star
36

xml2

Bindings to libxml2
R
218
star
37

gh

Minimalistic GitHub API client in R
R
218
star
38

cpp11

cpp11 helps you to interact with R objects using C++ code.
C++
199
star
39

keyring

๐Ÿ” Access the system credential store from R
R
191
star
40

vdiffr

Visual regression testing and graphical diffing with testthat
C++
182
star
41

svglite

A lightweight svg graphics device for R
C++
181
star
42

pillar

Format columns with colour
R
179
star
43

withr

Methods For Temporarily Modifying Global State
R
173
star
44

ragg

Graphic Devices Based on AGG
C++
172
star
45

hugodown

Make websites with hugo and RMarkdown
R
166
star
46

ymlthis

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

coro

Coroutines for R
R
153
star
48

rprojroot

Finding files in project subdirectories
R
148
star
49

debugme

Easy and efficient debugging for R packages
R
146
star
50

available

Check if a package name is available to use
R
142
star
51

gert

Simple git client for R
C
142
star
52

archive

R bindings to libarchive, supporting a large variety of archive formats
C++
142
star
53

ellipsis

Tools for Working with ...
R
141
star
54

later

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

itdepends

R
133
star
56

fastmap

Fast map implementation for R
C++
132
star
57

prettyunits

Pretty, human readable formatting of quantities
JavaScript
131
star
58

rray

Simple Arrays
R
130
star
59

isoband

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

tidyselect

A backend for functions taking tidyverse selections
R
123
star
61

desc

Manipulate DESCRIPTION files
R
121
star
62

evaluate

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

gargle

Infrastructure for calling Google APIs from R, including auth
R
114
star
64

rcmdcheck

Run R CMD check from R and collect the results
R
113
star
65

tree-sitter-r

R
106
star
66

prettycode

Syntax highlight R code in the terminal
R
101
star
67

sloop

S language OOP โ›ต๏ธ
R
101
star
68

clock

A Date-Time Library for R
R
100
star
69

mockery

A mocking library for R.
R
99
star
70

revdepcheck

R package reverse dependency checking
R
99
star
71

pkgdepends

R Package Dependency Resolution
R
94
star
72

lifecycle

Manage the life cycle of your exported functions and arguments
R
92
star
73

systemfonts

System Native Font Handling in R
C++
91
star
74

commonmark

High Performance CommonMark and Github Markdown Rendering in R
C
88
star
75

downlit

Syntax Highlighting and Automatic Linking
R
86
star
76

gtable

The layout packages that powers ggplot2
R
86
star
77

askpass

Password Entry for R, Git, and SSH
R
84
star
78

zip

Platform independent zip compression via miniz
C
83
star
79

rappdirs

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

clisymbols

Unicode symbols for CLI applications, with fallbacks
R
79
star
81

marquee

Markdown Parser and Renderer for R Graphics
C
77
star
82

ps

R package to query, list, manipulate system processes
C
73
star
83

credentials

Tools for Managing SSH and Git Credentials
R
72
star
84

sessioninfo

Print Session Information
R
72
star
85

pkgapi

Create a map of functions for an R package - WORK IN PROGRESS!
R
70
star
86

sodium

R bindings to libsodium
R
69
star
87

roxygen2md

Convert elements of roxygen documentation to markdown
R
67
star
88

backports

Reimplementations of Functions Introduced Since R-3.0.0
R
66
star
89

pkgbuild

Find tools needed to build R packages
R
65
star
90

webfakes

Fake web apps for HTTP testing R packages
C
63
star
91

generics

Common generic methods
R
61
star
92

cliapp

Rich Command Line Applications
R
61
star
93

diffviewer

HTML widget to visually compare files
JavaScript
58
star
94

pkgload

Simulate installing and loading a package
R
58
star
95

cachem

Key-value caches for R
R
57
star
96

liteq

Serverless R message queue using SQLite
R
56
star
97

brio

Basic R Input Output
R
53
star
98

carrier

Create standalone functions for remote execution
R
50
star
99

jose

Javascript Object Signing and Encryption for R
R
48
star
100

Rapp

Build CLI applications in R
R
46
star