Skip to content

Commit f155093

Browse files
committed
Update NEWS and README for 0.5.0
1 parent 899d714 commit f155093

File tree

3 files changed

+142
-28
lines changed

3 files changed

+142
-28
lines changed

NEWS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
# rig 0.5.0 (unreleased)
2+
# rig 0.5.0
33

44
* rig can now open renv projects in RStudio, with the correct R version.
55
Pass the renv lock file to rig: `rig rstudio .../renv.lock` (#74).

README.md

Lines changed: 140 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11

2+
23
# The R Installation Manager
34

45
Install, remove, configure R versions.
56

7+
8+
- [🚀  Features](#--features)
9+
- [🐞  Known Issues](#--known-issues)
10+
- [⬇️  Installation](#️--installation)
11+
- [⚙️  Usage](#️--usage)
12+
- [🤝  Feedback](#--feedback)
13+
- [❓  FAQ](#--faq)
14+
- [📘  License](#--license)
15+
616
## 🚀  Features
717

818
- Works on macOS, Windows and Linux (Ubuntu and Debian, x86_64 and
@@ -39,9 +49,6 @@ Install, remove, configure R versions.
3949
temporarily before starting RStudio and then changes it back after a
4050
short wait. If RStudio starts up very slowly, then the wait might be
4151
too short, and it might start up with the wrong R version.
42-
- If you delete the default R version with `rig rm` or another way,
43-
then the `R` and `RS` commands will kept, but they will point to a
44-
non-existing directory and fail.
4552
- On Windows Rtools installation will fail if the same version of
4653
Rtools is already installed.
4754

@@ -123,12 +130,12 @@ Chocolatey, so the installer and the version in Scoop might be newer.
123130
Download the latest releast from <https://github.com/r-lib/rig/releases>
124131
and uncompress it to `/usr/local`
125132

126-
curl -Ls https://github.com/r-lib/rig/releases/download/v0.4.1/rig-linux-0.4.1.tar.gz |
133+
curl -Ls https://github.com/r-lib/rig/releases/download/v0.5.0/rig-linux-0.5.0.tar.gz |
127134
sudo tar xz -C /usr/local
128135

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

131-
curl -Ls https://github.com/r-lib/rig/releases/download/v0.4.1/rig-linux-arm64-0.4.1.tar.gz |
138+
curl -Ls https://github.com/r-lib/rig/releases/download/v0.5.0/rig-linux-arm64-0.5.0.tar.gz |
132139
sudo tar xz -C /usr/local
133140

134141
Supported Linux distributions:
@@ -167,47 +174,154 @@ Run `rig` to see all commands and examples.
167174

168175
### Command list:
169176

170-
rig add -- install a new R version
171-
rig default -- print or set default R version
172-
rig library -- Manage package libraries [alias: lib] (experimental)
173-
rig list -- list installed R versions
177+
rig add -- install a new R version [alias: install]
178+
rig default -- print or set default R version [alias: switch]
179+
rig library -- manage package libraries [alias: lib] (experimental)
180+
rig list -- list installed R versions [alias: ls]
174181
rig resolve -- resolve a symbolic R version
175-
rig rm -- remove R versions
182+
rig rm -- remove R versions [aliases: del, delete, remove]
176183
rig rstudio -- start RStudio with the specified R version
184+
rig sysreqs -- manage R-related system libraries and tools (experimental) (macOS)
177185
rig system -- manage current installations
178186

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

181189
### macOS `rig system` subcommands
182190

183-
rig system add-pak -- install or update pak for an R version
184-
rig system allow-debugger -- allow debugging R with lldb and gdb
185-
rig system allow-core-dumps -- allow creating core dumps when R crashes
186-
rig system fix-permissions -- restrict system library permissions to admin
187-
rig system forget -- make system forget about R installations
188-
rig system make-links -- create R-* quick links
189-
rig system make-orthogonal -- make installed versions orthogonal
190-
rig system no-openmp -- remove OpenMP (-fopenmp) option for Apple compilers
191-
rig system setup-user-lib -- Set up automatic user package libraries
191+
rig system add-pak -- install or update pak for an R version
192+
rig system allow-debugger -- allow debugging R with lldb and gdb
193+
rig system allow-debugger-rstudio -- allow debugging RStudio with lldb and gdb
194+
rig system allow-core-dumps -- allow creating core dumps when R crashes
195+
rig system fix-permissions -- restrict system library permissions to admin
196+
rig system forget -- make system forget about R installations
197+
rig system make-links -- create R-* quick links
198+
rig system make-orthogonal -- make installed versions orthogonal
199+
rig system no-openmp -- remove OpenMP (-fopenmp) option for Apple compilers
200+
rig system setup-user-lib -- set up automatic user package libraries [alias: create-lib]
192201

193202
### Windows `rig system` subcommands
194203

195-
rig system add-pak -- install or update pak for an R version
196-
rig system clean-registry -- clean stale R related entries in the registry
197-
rig system make-links -- create R-* quick links
198-
rig system setup-user-lib -- Set up automatic user package libraries
204+
rig system add-pak -- install or update pak for an R version
205+
rig system clean-registry -- clean stale R related entries in the registry
206+
rig system make-links -- create R-* quick links
207+
rig system setup-user-lib -- set up automatic user package libraries [alias: create-lib]
208+
rig system update-rtools40 -- update Rtools40 MSYS2 packages
199209

200210
### Linux `rig system` subcommands
201211

202-
rig system add-pak -- install or update pak for an R version
203-
rig system make-links -- create R-* quick links
204-
rig system setup-user-lib -- Set up automatic user package libraries
212+
rig system add-pak -- install or update pak for an R version
213+
rig system make-links -- create R-* quick links
214+
rig system setup-user-lib -- set up automatic user package libraries [alias: create-lib]
205215

206216
## 🤝  Feedback
207217

208218
Please open an issue in our issue tracker at
209219
<https://github.com/r-lib/rig/issues>
210220

221+
## ❓  FAQ
222+
223+
<details>
224+
<summary>
225+
Why does rig create a user package library?
226+
</summary>
227+
228+
> Installing non-base packages into a user package library has several
229+
> benefits:
230+
>
231+
> - The system library is not writeable for regular users on some
232+
> systems (Windows and Linux, typically), so we might as well create
233+
> a properly versioned user library at the default place.
234+
> - Some tools need a clean R environment, with base packages only,
235+
> and do not work well if user packages are installed into the
236+
> system library. E.g. `R CMD check` is such a tool, and
237+
> <https://github.com/r-lib/revdepcheck> is another.
238+
> - You can delete an R installation (e.g. with `rig rm`) and then and
239+
> then install it again, without losing your R packages.
240+
241+
</details>
242+
<details>
243+
<summary>
244+
Why does rig install pak?
245+
</summary>
246+
247+
> To be able to install R packages efficiently, from CRAN, Bioconductor
248+
> or GitHub, right from the start. pak also supports installing system
249+
> libraries automatically on some Linux systems.
250+
>
251+
> If you don’t want `rig add` to install pak, use the `--without-pak`
252+
> option.
253+
254+
</details>
255+
<details>
256+
<summary>
257+
Why does rig change the permissions of the system library (on macOS)?
258+
</summary>
259+
260+
> To make sure that you don’t install packages accidentally into the
261+
> system library. See “Why does rig create a user package library?”
262+
> above.
263+
264+
</details>
265+
<details>
266+
<summary>
267+
Why does rig set the default CRAN mirror?
268+
</summary>
269+
270+
> To avoid the extra work the users need to spend on this.
271+
>
272+
> The <https://cloud.r-project.org> mirror is usually better than the
273+
> other, in that it is a CDN that is close to most users, and that it is
274+
> updated more often.
275+
>
276+
> If you want to use a different mirror, you can set the `repos` option
277+
> in your `.Rprofile`, so the rig repo settings will be ignored.
278+
>
279+
> You can also use the `--without-cran-mirror` option of `rig add`.
280+
281+
</details>
282+
<details>
283+
<summary>
284+
Why does rig set up RSPM?
285+
</summary>
286+
287+
> RSPM ([Rstudio Package
288+
> Manager](https://packagemanager.rstudio.com/client/#/)) is generally
289+
> superior to a refular CRAN mirror on Windows and many Linux systems.
290+
>
291+
> On Linux it includes binary packages for many popular distributions.
292+
>
293+
> On Windows, it includes up to date binary packages for older R
294+
> versions as well.
295+
>
296+
> To avoid RSPM, use the `--without-rspm` option of `rig add`.
297+
298+
</details>
299+
<details>
300+
<summary>
301+
Can rig install R without admin permissions
302+
</summary>
303+
304+
> No, currently it cannot.
305+
306+
</details>
307+
<details>
308+
<summary>
309+
How is rig different from RSwitch?
310+
</summary>
311+
312+
> While there is a small overlap in functionality, rig and
313+
> [RSwitch](https://rud.is/rswitch/) are very different. I suggest you
314+
> look over the features of both to decide which one suits your needs
315+
> better.
316+
>
317+
> If you like rig and also like the extra features of RSwitch, then you
318+
> can use them together just fine: changing the default R version in
319+
> RSwitch also changes it in rig and vice versa. You can use the rig cli
320+
> and the RSwitch app together, or you can also use both menu bar apps
321+
> at the same time.
322+
323+
</details>
324+
211325
## 📘  License
212326

213327
MIT 2021-2022 © RStudio Pbc.

RELEASE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
- [ ] Make sure version number is updated everywhere:
44
- Cargo.toml
55
- Cargo.lock (run cargo build)
6-
- src/args.rs
76
- rig.iss
87
- NEWS file
98
- README.Rmd
@@ -29,3 +28,4 @@
2928
`--tags` as well.
3029
- [ ] Update homebrew repo.
3130
- [ ] Update choco package.
31+
- [ ] tweet

0 commit comments

Comments
 (0)