summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorRicardo Wurmus <rekado@elephly.net>2021-02-09 12:51:02 +0100
committerRicardo Wurmus <rekado@elephly.net>2021-02-09 12:51:02 +0100
commita90a1f37e007c8d5676332f387600aca4a9966c3 (patch)
tree7198ed52515a455430ff9798de063d8b8f635cee /README
Initial commit.
Diffstat (limited to 'README')
-rw-r--r--README14
1 files changed, 14 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..a9c9d98
--- /dev/null
+++ b/README
@@ -0,0 +1,14 @@
+This R package provides a single procedure =guix.install=, which
+allows R users to install R packages via Guix right from within their
+running R session.
+
+If the requested R package does not exist in Guix at this time, the
+package and all its missing dependencies will be imported recursively
+and the generated package definitions will be written to
+=~/.Rguix/packages.scm=. This record of imported packages can be used
+later to reproduce the environment, and to add the packages in
+question to a proper Guix channel (or Guix itself).
+
+=guix.install= not only supports installing packages from CRAN, but
+also from Bioconductor or even arbitrary git or mercurial
+repositories, replacing the need for installation via devtools. \ No newline at end of file