about summary refs log tree commit diff
path: root/pkgs/development/r-modules/README.md
diff options
context:
space:
mode:
authorChris Hodapp <hodapp87@gmail.com>2017-01-27 18:54:50 -0500
committerChris Hodapp <hodapp87@gmail.com>2017-01-27 18:54:50 -0500
commit7638578342fa7b053095a4f89cc65cba8c70b3a2 (patch)
tree34f91b18288af4a714a32fa8cc579c3cb93a1039 /pkgs/development/r-modules/README.md
parentd75035fbf818981327605a099b4ddff62c9e74ca (diff)
RStudio: Optionally allow packages from custom R environment
https://nixos.org/nixpkgs/manual/#r-packages contains a method for
setting up an R environment with a specific set of libraries, and it
creates an R wrapper which points R to those libraries.

The package RStudio relies on the standard R package, which then
cannot access any of the libraries specified in a custom R
environment.  While one may easily use pkgs.rstudio.override to change
rstudio's R dependency to the custom R environment, this accomplishes
nothing because while RStudio runs the correct R wrapper it clears out
the environment variable R_LIBS_SITE - and so it is still unable to
use any of those packages.

In order to work around this problem, these changes allow the user to
optionally modify rstudio's wrapper to set environment variable
R_PROFILE_USER to an R script which sets R's .libPaths(..) to point to
the same libraries; that script is generated from R_LIBS_SITE in the R
wrapper.

By default, this change has no effect.  If R is overridden to
something else, and if useRPackages is changed from its default of
false, then the change described above is made; for instance:

{
  packageOverrides = pkgs: let self = pkgs.pkgs; in
  rec {
    rEnv = pkgs.rWrapper.override {
      packages = with self.rPackages; [
        dplyr ggplot2 e1071 rpart reshape
      ];
    };
    rstudioEnv = pkgs.rstudio.override { R = rEnv; useRPackages = true; };
  };
}
Diffstat (limited to 'pkgs/development/r-modules/README.md')
-rw-r--r--pkgs/development/r-modules/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/pkgs/development/r-modules/README.md b/pkgs/development/r-modules/README.md
index e384b375460a9..9a7ccc55ac915 100644
--- a/pkgs/development/r-modules/README.md
+++ b/pkgs/development/r-modules/README.md
@@ -53,6 +53,37 @@ in with pkgs; {
 and then run `nix-shell .` to be dropped into a shell with those packages
 available.
 
+## RStudio
+
+RStudio by default will not use the libraries installed like above.
+You must override its R version with your custom R environment, and
+set `useRPackages` to `true`, like below:
+
+```nix
+{
+    packageOverrides = super: let self = super.pkgs; in
+    {
+
+        rEnv = super.rWrapper.override {
+            packages = with self.rPackages; [ 
+                devtools
+                ggplot2
+                reshape2
+                yaml
+                optparse
+                ];
+        };
+        rstudioEnv = super.rstudio.override {
+            R = rEnv;
+            useRPackages = true;
+        };
+    };
+}
+```
+
+Then like above, `nix-env -f "<nixpkgs>" -iA rstudioEnv` will install
+this into your user profile.
+
 ## Updating the package set
 
 ```bash