diff options
| author | Justin Bedo <cu@cua0.org> | 2021-09-26 07:29:58 +1000 |
|---|---|---|
| committer | Justin Bedo <cu@cua0.org> | 2021-09-26 07:29:58 +1000 |
| commit | 5309818bf744a166a236ee2f829c154975cf6bcc (patch) | |
| tree | 4b5f182aa669f720cf36a450faf2ab65e371cd45 /doc/languages-frameworks/r.section.md | |
| parent | 9bc37bff1afd0bc3fc5b851ee4512ea4478fc583 (diff) | |
doc: clarify location of rPackages overrides
Detail the location of rPackage overrides and how broken builds should be addressed.
Diffstat (limited to 'doc/languages-frameworks/r.section.md')
| -rw-r--r-- | doc/languages-frameworks/r.section.md | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/languages-frameworks/r.section.md b/doc/languages-frameworks/r.section.md index 6b64e264b6692..ad0fb10987c98 100644 --- a/doc/languages-frameworks/r.section.md +++ b/doc/languages-frameworks/r.section.md @@ -96,6 +96,11 @@ re-enter the shell. ## Updating the package set {#updating-the-package-set} +There is a script and associated environment for regenerating the package +sets and synchronising the rPackages tree to the current CRAN and matching +BIOC release. These scripts are found in the `pkgs/development/r-modules` +directory and executed as follows: + ```bash nix-shell generate-shell.nix @@ -112,4 +117,11 @@ Rscript generate-r-packages.R bioc-experiment > bioc-experiment-packages.nix.new mv bioc-experiment-packages.nix.new bioc-experiment-packages.nix ``` -`generate-r-packages.R <repo>` reads `<repo>-packages.nix`, therefor the renaming. +`generate-r-packages.R <repo>` reads `<repo>-packages.nix`, therefore +the renaming. + +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` +contents are automatically generated it should not be edited and broken +builds should be addressed using overrides. |