From 11c32ac3f54adbe333197d4b76441f26bc70b332 Mon Sep 17 00:00:00 2001 From: Tom Palmer Date: Tue, 15 Oct 2024 15:43:25 +0100 Subject: [PATCH] Add rstudio subcommand docs --- docs/opensafely-cli.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/opensafely-cli.md b/docs/opensafely-cli.md index af7d53b02..aff6df82c 100644 --- a/docs/opensafely-cli.md +++ b/docs/opensafely-cli.md @@ -195,6 +195,27 @@ opensafely exec IMAGE bash This can be useful if you want to explore the image manually. +### `rstudio` - Running rstudio-server + +This provides the RStudio interface to the r image, therefore, the versions of R and all the packages are the same as they are in the r image. + +To launch an RStudio Server session please navigate to your research repository and run + +```bash +opensafely rstudio +``` + +This will launch an RStudio Server session in a browser window. A message in your terminal will tell you which port to browse to. + +In your RStudio Server session you can work on your files as usual, including saving your edits. + +If you have an `.Rproj` file at the top level of your repository, the command will detect this and will open the RStudio Server session in RStudio's project mode. In this mode the Git pane is available, so you can make commits, or you can make commits locally as you usually do. + +To end your RStudio Server session press ++ctrl+c++ in the Terminal window in which you ran the `opensafely run` command. + +An alternative method to open your project in an RStudio Server session is to open your research repository in [Codespaces](/getting-started/how-to/use-github-codespaces-in-your-project/#how-to-access-rstudio). + + ### `jupyter` - Running JupyterLab [Jupyter notebooks](https://jupyter.org/) are useful interactive