Giter Club home page Giter Club logo

binder's Introduction

Template for RStudio on Binder / JupyterHub

Binder

Generate a Git repository that can run R code with RStudio on the browser via mybinder.org or any JupyterHub from this template repository!

Based on the rocker/geospatial image.

How to use this reop

1. Create a new repo using this as a template

Use the Use this template button on GitHub. Use a descriptive name representing the GUI app you are running / demoing. You can then follow the rest of the instructions in this README from your newly created repository.

2. Install any packages you want

You can create an install.R file that will be executed on build. Use install.packages or devtools::install_version.

install.packages("ggplot2")

Packages are installed from packagemanager.rstudio.com, and binary packages are preferred wherever possible. For some R packages, you might need to install system packages via apt - you can do so by writing out a list of apt package names in apt.txt.

3. Modify the Binder Badge in the README.md

The 'Launch on Binder' badge in this README points to the template repository. You should modify it to point to your own repository. Keep the urlpath=rstudio parameter intact - that is what makes sure your repo will launch directly into RStudio

4. Add your R code and update README

Finally, add the R code you want to demo to the repository! Cleanup the README too so it talks about your code, not these instructions on setting up this repo

Troubleshooting

It didn't work! What do I do now?. If you are installing additional R *packages, this will sometimes fail when a package requires an external library *that is not found on the container. We're working on a more elegant solution *for this case, but meanwhile, you'll need to modify the Dockerfile to install *these libraries. For instance, the gsl R package page *reads

# Install System Prerequisites for Ubuntu 20.04 (focal)
apt-get install -y libgsl0-dev

To solve this, you will need to add the following line to your apt.txt file:

libgsl0-dev

Or, just get in touch by opening an issue. We'll try and resolve common cases so more things work out of the box.

binder's People

Contributors

amoeba avatar betatim avatar brooksambrose avatar cboettig avatar eitsupi avatar krlmlr avatar nuest avatar rokroskar avatar rossibarra avatar yuvipanda avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.