diff options
| author | TomaSajt | 2024-07-24 13:07:30 +0200 |
|---|---|---|
| committer | TomaSajt | 2024-07-31 18:28:38 +0200 |
| commit | 7224c89e7282f549259726bdc3e4dc213f50faac (patch) | |
| tree | 4fc0b305a45c3dba72a73649f5acb3a2dbae1f74 /doc | |
| parent | d0dd8b9ff24d707ede81c893fb96af9fbe673195 (diff) | |
doc: update R section to mention .json files
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/languages-frameworks/r.section.md | 23 |
1 files changed, 13 insertions, 10 deletions
diff --git a/doc/languages-frameworks/r.section.md b/doc/languages-frameworks/r.section.md index ad0fb10987c9..d25c5e848232 100644 --- a/doc/languages-frameworks/r.section.md +++ b/doc/languages-frameworks/r.section.md @@ -104,24 +104,27 @@ directory and executed as follows: ```bash nix-shell generate-shell.nix -Rscript generate-r-packages.R cran > cran-packages.nix.new -mv cran-packages.nix.new cran-packages.nix +Rscript generate-r-packages.R cran > cran-packages.json.new +mv cran-packages.json.new cran-packages.json -Rscript generate-r-packages.R bioc > bioc-packages.nix.new -mv bioc-packages.nix.new bioc-packages.nix +Rscript generate-r-packages.R bioc > bioc-packages.json.new +mv bioc-packages.json.new bioc-packages.json -Rscript generate-r-packages.R bioc-annotation > bioc-annotation-packages.nix.new -mv bioc-annotation-packages.nix.new bioc-annotation-packages.nix +Rscript generate-r-packages.R bioc-annotation > bioc-annotation-packages.json.new +mv bioc-annotation-packages.json.new bioc-annotation-packages.json -Rscript generate-r-packages.R bioc-experiment > bioc-experiment-packages.nix.new -mv bioc-experiment-packages.nix.new bioc-experiment-packages.nix +Rscript generate-r-packages.R bioc-experiment > bioc-experiment-packages.json.new +mv bioc-experiment-packages.json.new bioc-experiment-packages.json ``` -`generate-r-packages.R <repo>` reads `<repo>-packages.nix`, therefore +`generate-r-packages.R <repo>` reads `<repo>-packages.json`, therefore the renaming. +The contents of a generated `*-packages.json` file will be used to +create a package derivation for each R package listed in the file. + Some packages require overrides to specify external dependencies or other patches and special requirements. These overrides are specified in the -`pkgs/development/r-modules/default.nix` file. As the `*-packages.nix` +`pkgs/development/r-modules/default.nix` file. As the `*-packages.json` contents are automatically generated it should not be edited and broken builds should be addressed using overrides. |