Skip to content

Commit 9ab458c

Browse files
Apply suggestions from code review
Co-authored-by: Becky Smith <becky.smith@thedatalab.org>
1 parent 87e4df7 commit 9ab458c

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/opensafely-cli.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -196,11 +196,11 @@ This can be useful if you want to explore the image manually.
196196

197197
### `launch` - Run web based interactive tools
198198

199-
Many users may prefer to use some of the interactive development environments that are commonly used for different languages, like Rstudio or Jupyter Lab.
199+
Many users may prefer to use some of the interactive development environments that are commonly used for different languages, like RStudio or JupyterLab.
200200

201-
Using `opensafely launch`, you can run these tools from the OpenSAFELY images, accessing them via your browser. This means that code you write and run in these tools will be running the OpenSAFELY provided environment, with the right dependencies and versions, rather than what ever you have installed on your machine.
201+
Using `opensafely launch`, you can run these tools from the OpenSAFELY images, accessing them via your browser. This means that code you write and run in these tools will be running the OpenSAFELY-provided environment, with the right dependencies and versions, rather than whatever you have installed on your own machine.
202202

203-
The supported tools of Rstudio and Jupyter Lab are documented below, but they share a common set of options, which you can see with
203+
The supported tools of RStudio and JupyterLab are documented below, but they share a common set of options, which you can see with
204204

205205
```
206206
opensafely launch --help
@@ -209,8 +209,8 @@ opensafely launch --help
209209

210210
#### `opensafely launch rstudio` - Running RStudio Server
211211

212-
This sub-command provides the RStudio interface to the r image. This lets you run your code in RStudio using the same versions of R and all the packages that are the OpenSAFELY secure backend.
213-
Note that if you are using a Github [Codespaces](/getting-started/how-to/use-github-codespaces-in-your-project/#how-to-access-rstudio), then this is run automatically for you.
212+
This sub-command provides the RStudio interface to the R image. This lets you run your code in RStudio using the same versions of R and all the packages that are available in the OpenSAFELY secure backend.
213+
Note that if you are using a Github [Codespace](/getting-started/how-to/use-github-codespaces-in-your-project/#how-to-access-rstudio), then this is run automatically for you.
214214

215215
To launch an RStudio Server session please navigate to your research repository and run
216216

@@ -232,7 +232,7 @@ If you have an `.Rproj` file at the top level of your repository, the command wi
232232

233233
To end your RStudio Server session press ++ctrl+c++ in the Terminal window in which you ran the `opensafely rstudio` command.
234234

235-
Note that the `opensafely` CLI is not vendored within the RStudio image. Hence to use CLI commands such as `opensafely run`, please do so from a local Terminal session and not from the Terminal pane in your RStudio Server session. Whereas, the `opensafely` CLI is vendored within the Codespaces version of RStudio Server, and so you can use the RStudio Terminal in this case.
235+
Note that the `opensafely` CLI is not available within the RStudio image. Hence to use CLI commands such as `opensafely run`, please do so from a local Terminal session and not from the Terminal pane in your RStudio Server session. If you are using a Codespace, the `opensafely` CLI **is** availablle within the RStudio Server session, and so you can use the RStudio Terminal in this case.
236236

237237
Users with Apple Silicon computers need to [enable Rosetta emulation](/install-docker/#macs-with-an-apple-silicon-processor). Since Docker Desktop 4.25.0 this feature has been enabled by default. For Docker Desktop versions between 4.16.0 and 4.24.4 this setting can be found in Settings under the _Features in development_ and then _Beta features_ tab. The `opensafely rstudio` command will not run under either the Docker Virtual Machine Manager virtualization (since Docker Desktop 4.35.0) nor the legacy QEMU virtualization.
238238

@@ -263,10 +263,10 @@ copy the long URL shown by the JupyterLab logs — starting
263263
`http://localhost`… — and use that URL in a web
264264
browser to access JupyterLab.
265265

266-
By default, it will run Jupyter Lab in the most recent version of the python image, but you can to run an older version with:
266+
By default, it will run JupyterLab in the most recent version of the python image, but you can to run an older version with:
267267

268268
```bash
269-
opensafely launch juypter:v1
269+
opensafely launch jupyter:v1
270270
```
271271

272272
To exit, press ++control+c++ in the command line - this also shuts down the container.

0 commit comments

Comments
 (0)