Skip to content

Commit 7224c89

Browse files
committed
doc: update R section to mention .json files
1 parent d0dd8b9 commit 7224c89

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

doc/languages-frameworks/r.section.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -104,24 +104,27 @@ directory and executed as follows:
104104
```bash
105105
nix-shell generate-shell.nix
106106

107-
Rscript generate-r-packages.R cran > cran-packages.nix.new
108-
mv cran-packages.nix.new cran-packages.nix
107+
Rscript generate-r-packages.R cran > cran-packages.json.new
108+
mv cran-packages.json.new cran-packages.json
109109

110-
Rscript generate-r-packages.R bioc > bioc-packages.nix.new
111-
mv bioc-packages.nix.new bioc-packages.nix
110+
Rscript generate-r-packages.R bioc > bioc-packages.json.new
111+
mv bioc-packages.json.new bioc-packages.json
112112

113-
Rscript generate-r-packages.R bioc-annotation > bioc-annotation-packages.nix.new
114-
mv bioc-annotation-packages.nix.new bioc-annotation-packages.nix
113+
Rscript generate-r-packages.R bioc-annotation > bioc-annotation-packages.json.new
114+
mv bioc-annotation-packages.json.new bioc-annotation-packages.json
115115

116-
Rscript generate-r-packages.R bioc-experiment > bioc-experiment-packages.nix.new
117-
mv bioc-experiment-packages.nix.new bioc-experiment-packages.nix
116+
Rscript generate-r-packages.R bioc-experiment > bioc-experiment-packages.json.new
117+
mv bioc-experiment-packages.json.new bioc-experiment-packages.json
118118
```
119119

120-
`generate-r-packages.R <repo>` reads `<repo>-packages.nix`, therefore
120+
`generate-r-packages.R <repo>` reads `<repo>-packages.json`, therefore
121121
the renaming.
122122

123+
The contents of a generated `*-packages.json` file will be used to
124+
create a package derivation for each R package listed in the file.
125+
123126
Some packages require overrides to specify external dependencies or other
124127
patches and special requirements. These overrides are specified in the
125-
`pkgs/development/r-modules/default.nix` file. As the `*-packages.nix`
128+
`pkgs/development/r-modules/default.nix` file. As the `*-packages.json`
126129
contents are automatically generated it should not be edited and broken
127130
builds should be addressed using overrides.

0 commit comments

Comments
 (0)