Skip to content

Commit

Permalink
vignette links
Browse files Browse the repository at this point in the history
  • Loading branch information
Bruno Rodrigues committed Jan 24, 2024
1 parent 0d62b70 commit 78f1f0a
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ start using them.
## Getting started for new users

To get started with `{rix}` and Nix, you should read the following vignette
`vignette("1-getting_started")`. The vignettes are numbered to get you to learn
`vignette("1-getting-started")`. The vignettes are numbered to get you to learn
how to use `{rix}` and Nix smoothly. There’s a lot of info, so take your time
reading the vignettes. Don’t hesitate to open an issue if something is not
clear.
Expand Down
2 changes: 1 addition & 1 deletion dev/1-getting_started.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ This `default.nix` can in turn be used by Nix to build an environment containing
the latest version of R, with the `{dplyr}` and `{chronicler}` packages.

Take note of the `ide = "other"` argument: this argument, and the values it
can take, are further discussed in the vignette `vignette("5-interactive_use")`
can take, are further discussed in the vignette `vignette("5-interactive-use")`
but continue reading this vignette and then vignettes numbered by a "4".

### Using default.nix files
Expand Down
5 changes: 3 additions & 2 deletions dev/2b-macos.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,10 @@ on macOS. When you try to generate an expression with `ide =
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")`;

- help us package RStudio for macOS on `nixpgs`. See
[https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/rstudio/default.nix](the
expression for RStudio).
[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")`.
6 changes: 3 additions & 3 deletions dev/3-building_envs_with_rix.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ The ideal workflow when using `{rix}` is to create a new, separate environment
at the start of a project. Let's say that you wish to analyse some data set, and
need `{dplyr}` and `{ggplot2}`. Let's also suppose that you use VS Code as your
IDE (there will be more discussion on editors in the vignette
`vignette("5-interactive_use")` but for now, let’s assume that you use VS Code).
`vignette("5-interactive-use")` but for now, let’s assume that you use VS Code).
With the `rix::rix()` function, you can easily generate the right `default.nix`
file. You need to provide the following inputs to `rix()`:

- `r_ver`: the version of R required. Use "latest" for the latest version;
- `r_pkgs`: the required R packages. For example "dplyr" (more on this in the vignette `vignette("4a-installing-r-packages-in-a-nix-environment")`);
- `system_pkgs`: the required system packages, if needed. For example "quarto", or a Python interpreter (more on this in the vignette `vignette("4b-installing-system-tools-and-texlive-packages-in-a-nix-environment")`);
- `git_pkgs`: list of git packages to add (more on this in the vignette `vignette("4a-installing-r-packages-in-a-nix-environment")`);
- `ide`: the integrated development editor to use (more on this in the vignette `vignette("5-interactive_use")`)
- `ide`: the integrated development editor to use (more on this in the vignette `vignette("5-interactive-use")`)
- `path`: the path where to save the `default.nix` file.
- `overwrite`: whether to overwrite the `default.nix` file or not.
- `print`: whether to print the `default.nix` file to the console or not.
Expand Down Expand Up @@ -68,7 +68,7 @@ nix-shell
This will activate the environment. If you have VS Code installed you can
start it from this environment and VS Code will use this specific R version
library of packages. We will explore this in greater detail in the vignette
`vignette("5-interactive_use")`.
`vignette("5-interactive-use")`.

## Running old projects with {rix}

Expand Down
2 changes: 1 addition & 1 deletion dev/4b-install_sys_pkgs.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,4 @@ literate programming, refer to the vignette
Environments built with Nix are not completely cut off from the rest of your
system, and as such, you should be able to use your usual IDE to interact with
Nix environments. The only exception is RStudio. Everything will be explained in
greater detail in the vignette `vignette("5-interactive_use")`.
greater detail in the vignette `vignette("5-interactive-use")`.
2 changes: 1 addition & 1 deletion vignettes/1-getting-started.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ This `default.nix` can in turn be used by Nix to build an environment containing
the latest version of R, with the `{dplyr}` and `{chronicler}` packages.

Take note of the `ide = "other"` argument: this argument, and the values it
can take, are further discussed in the vignette `vignette("5-interactive_use")`
can take, are further discussed in the vignette `vignette("5-interactive-use")`
but continue reading this vignette and then vignettes numbered by a "4".


Expand Down

0 comments on commit 78f1f0a

Please sign in to comment.