Skip to content

Commit

Permalink
Merge pull request #27 from pablobernabeu/patch-2
Browse files Browse the repository at this point in the history
  • Loading branch information
choldgraf authored Jul 29, 2020
2 parents 0893546 + 8f135ce commit ffb7d59
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ snapshot on [MRAN](https://mran.microsoft.com/documents/rro/reproducibility).

**Note:** An alternative is to use the [holepunch package for R](https://karthik.github.io/holepunch/articles/getting_started.html).

### Requirements and suggestions

You need to have a `runtime.txt` file that is formatted like:

```
Expand All @@ -30,11 +32,22 @@ Both [RStudio](https://www.rstudio.com/) and [IRKernel](https://irkernel.github.
are installed by default, so you can use either the Jupyter notebook interface or
the RStudio interface.

This repository also contains an example of a Shiny app.
This repository also contains an example of a [Shiny app](https://github.com/binder-examples/r/tree/master/bus-dashboard).

### URL addresses for RStudio and Shiny environments

The Binder repository can be used to allow anyone to access an RStudio environment containing our code and data right
in their web browser. It also allows hosting a Shiny app. For those purposes, we have to append a bit of text to the
URL of our Binder repository, which we can find out at [mybinder.org](https://mybinder.org/) when we enter
the URL of our original repository from GitHub or Figshare, etc.

Last, note that if your Binder URL points to a folder, as in
- For the RStudio environment, we must add the following at the end of the URL: `?urlpath=rstudio`

http://mybinder.org/v2/gh/binder-examples/r/master?urlpath=shiny/bus-dashboard/,
- Example: http://mybinder.org/badge_logo.svg)](http://mybinder.org/v2/gh/binder-examples/r/master?urlpath=rstudio

- For the Shiny app environment, we must add the following at the end of the URL: `?urlpath=shiny`. In this case, we
also have to note that if the Shiny app files are located in a folder, this folder should be specified in the URL,
after a slash. We would then also have to put in a trailing slash at the end of the URL, and to avoid spaces in the
name of the repository, placing instead a hyphen (the reason is that spaces are converted to `%20`).

you will need (1) to put in the final slash in the URL, and (2) to avoid converted
spaces-'%20'-in the URL, instead placing a hyphen.
- Example: http://mybinder.org/v2/gh/binder-examples/r/master?urlpath=shiny/bus-dashboard/

0 comments on commit ffb7d59

Please sign in to comment.