Skip to content

Commit

Permalink
updated links in vignettes
Browse files Browse the repository at this point in the history
  • Loading branch information
Bruno Rodrigues committed Jan 25, 2024
1 parent 9240747 commit 8d2da7d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ library(rix)

*This vignette will discuss Linux and Windows-specific topics. If you're not
using either of these systems, you can ignore this vignette, and read the
`vignette("2b-setting-up-and-using-rix-on-macos")`
`vignette("b2-setting-up-and-using-rix-on-macos")`
vignette instead.*


Expand Down Expand Up @@ -148,8 +148,8 @@ rix(r_ver = "latest",
to generate a `default.nix`, and then use that file to generate an environment
with R, `{dplyr}` and `{ggplot2}`. If you need to add packages for your project,
rerun the command above, but add the needed packages to `r_pkgs`. This is
detailled in the vignette `vignette("4a-installing-r-packages-in-a-nix-environment")` and
`vignette("4b-installing-system-tools-and-texlive-packages-in-a-nix-environment")`.
detailled in the vignette `vignette("d1-installing-r-packages-in-a-nix-environment")` and
`vignette("d2-installing-system-tools-and-texlive-packages-in-a-nix-environment")`.


## Generating expressions
Expand All @@ -169,5 +169,5 @@ install.packages("rix", repos = c("https://b-rodrigues.r-universe.dev",
```

You can then use the `{rix}` package to generate expressions. Consult the
next vignette `vignette("3-using-rix-to-build-project-specific-environments")` to learn more.
next vignette `vignette("c-using-rix-to-build-project-specific-environments")` to learn more.

14 changes: 7 additions & 7 deletions vignettes/b2-setting-up-and-using-rix-on-macos.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ library(rix)

*This vignette will discuss macOS-specific topics. If you're not using macOS, you
can ignore this vignette, and read the
`vignette("2a-setting-up-and-using-rix-on-linux-and-windows")`
`vignette("b1-setting-up-and-using-rix-on-linux-and-windows")`
vignette instead.*


Expand Down Expand Up @@ -85,8 +85,8 @@ rix(r_ver = "latest",
to generate a `default.nix`, and then use that file to generate an environment
with R, `{dplyr}` and `{ggplot2}`. If you need to add packages for your project,
rerun the command above, but add the needed packages to `r_pkgs`. This is
detailled in the vignette `vignette("4a-installing-r-packages-in-a-nix-environment")` and
`vignette("4b-installing-system-tools-and-texlive-packages-in-a-nix-environment")`.
detailled in the vignette `vignette("d1-installing-r-packages-in-a-nix-environment")` and
`vignette("d2-installing-system-tools-and-texlive-packages-in-a-nix-environment")`.


## Generating expressions
Expand All @@ -106,7 +106,7 @@ install.packages("rix", repos = c("https://b-rodrigues.r-universe.dev",
```

You can then use the `{rix}` package to generate expressions. Consult the
next vignette `vignette("3-using-rix-to-build-project-specific-environments")` to learn more.
next vignette `vignette("c-using-rix-to-build-project-specific-environments")` to learn more.


## More macOS specificities
Expand Down Expand Up @@ -140,17 +140,17 @@ on macOS. When you try to generate an expression with `ide =
- if you're working on a pipeline with the `{targets}` package, you could run it
on Github Actions. This means you could work on the code on RStudio outside
of the Nix environment, as the code will only be executed on Github Actions runners. See this
vignette `vignette("advanced-topic-reproducible-analytical-pipelines-with-nix")` for further details;
vignette `vignette("z-advanced-topic-reproducible-analytical-pipelines-with-nix")` for further details;
- work on your project as usual, using your usual installation of R and RStudio,
but generate a `default.nix` at the end with `ide = "other"` with the right
version of R for reproducibility purposes;
- use subshells to execute only the code you need to run in a specific
environment. See this vignette `vignette("advanced-topic-running-r-or-shell-code-in-nix-from-r")`;
environment. See this vignette `vignette("z-advanced-topic-running-r-or-shell-code-in-nix-from-r")`;

- help us package RStudio for macOS on `nixpgs`. See
[here](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/rstudio/default.nix),
the Nix expression for RStudio.

We recommend you continue with the next vignette before tackling the more advanced
topics listed above: `vignette("3-using-rix-to-build-project-specific-environments")`.
topics listed above: `vignette("c-using-rix-to-build-project-specific-environments")`.

0 comments on commit 8d2da7d

Please sign in to comment.