[r-ver][r2u] add notes about rstudio-server and r-history (#25)

Close #23
rocker-org · Sep 14, 2023 · 58b07bb · 58b07bb
1 parent 4ca43f5
commit 58b07bb
Show file tree

Hide file tree

Showing 2 changed files with 69 additions and 1 deletion.
diff --git a/src/r-ver/NOTES.md b/src/r-ver/NOTES.md
@@ -51,9 +51,23 @@ by setting `postCreateCommand` as follows.
 
 The package cache is shared by all containers on the same machine, so later builds can be faster.
 
+## Use [RStudio Server](https://posit.co/products/open-source/rstudio-server/)
+
+[The `ghcr.io/rocker-org/devcontainer-features/rstudio-server` Feature](https://github.com/rocker-org/devcontainer-features/tree/main/src/rstudio-server)
+can be used to install and configure RStudio Server.
+
+```json
+{
+    "image": "ghcr.io/rocker-org/devcontainer/r-ver:4",
+    "features": {
+        "ghcr.io/rocker-org/devcontainer-features/rstudio-server:latest": {}
+    }
+}
+```
+
 ## Use [Jupyter](https://jupyter.org/)
 
-[The `ghcr.io/rocker-org/devcontainer-features/r-rig` feature](https://github.com/rocker-org/devcontainer-features/tree/main/src/r-rig)
+[The `ghcr.io/rocker-org/devcontainer-features/r-rig` Feature](https://github.com/rocker-org/devcontainer-features/tree/main/src/r-rig)
 can be used to install `jupyterlab` and `IRkernel`.
 (Remember to set `"version": "none"` for not to install another R)
 
@@ -68,3 +82,18 @@ can be used to install `jupyterlab` and `IRkernel`.
     }
 }
 ```
+
+## Make R console history persistent
+
+Normally the R console history is lost when we recreate the container,
+but we can preserve the history with
+[The `ghcr.io/rocker-org/devcontainer-features/r-history` Feature](https://github.com/rocker-org/devcontainer-features/tree/main/src/r-history).
+
+```json
+{
+    "image": "ghcr.io/rocker-org/devcontainer/r-ver:4",
+    "features": {
+        "ghcr.io/rocker-org/devcontainer-features/r-history:0": {}
+    }
+}
+```
diff --git a/src/r2u/NOTES.md b/src/r2u/NOTES.md
@@ -12,6 +12,25 @@ This template pulls the `linux/amd64` platform image because
 Since `bspm` is enabled, the binary R packages (from `r2u` repository) and system dependencies can be installed
 via the `install.package` R function.
 
+## Use [RStudio Server](https://posit.co/products/open-source/rstudio-server/)
+
+[The `ghcr.io/rocker-org/devcontainer-features/rstudio-server` Feature](https://github.com/rocker-org/devcontainer-features/tree/main/src/rstudio-server)
+can be used to install and configure RStudio Server.
+
+```jsonc
+"features": {
+    "ghcr.io/rocker-org/devcontainer-features/r-apt:0": {
+        "vscodeRSupport": "full",
+        "installDevTools": true,
+        "installRMarkdown": true,
+        "installRadian": true,
+        "installVscDebugger": true,
+        "installBspm": true,
+    },
+    "ghcr.io/rocker-org/devcontainer-features/rstudio-server:latest": {} // This line
+}
+```
+
 ## Use [Jupyter](https://jupyter.org/)
 
 The `InstallJupyterlab` option of
@@ -31,3 +50,23 @@ Only add `"installJupyterlab": true` to `devcontainer.json` like below.
     "installJupyterlab": true // This line
 }
 ```
+
+## Make R console history persistent
+
+Normally the R console history is lost when we recreate the container,
+but we can preserve the history with
+[The `ghcr.io/rocker-org/devcontainer-features/r-history` Feature](https://github.com/rocker-org/devcontainer-features/tree/main/src/r-history).
+
+```jsonc
+"features": {
+    "ghcr.io/rocker-org/devcontainer-features/r-apt:0": {
+        "vscodeRSupport": "full",
+        "installDevTools": true,
+        "installRMarkdown": true,
+        "installRadian": true,
+        "installVscDebugger": true,
+        "installBspm": true,
+    },
+    "ghcr.io/rocker-org/devcontainer-features/r-history:0": {} // This line
+}
+```