payton1004/contained-revealr

Self-contained repo for interactive stats-driven presentations

Contained revealR

Self-contained repo for interactive stats-driven presentations

---

Let's make some interactive presentations!

You can view the presentation here: https://raoofphysics.github.io/contained-revealr/

The slides should also be available on a mobile browser, although Firefox on Android isn't loading the interactive plots for some reason. Against my better judgement, I recommend you use Chrome on Android to view the content.

If you use hypothes.is, please annotate the presentation! I will be grateful for any notes you leave.

To use this workflow, grab the Dockerfile and docker-compose.yml files from this repo, fire up Docker, and get RStudio running in your browser. The Docker image in question (rocker/verse, brought to you by the wonderful people behind rocker-org) should contain all the main dependencies needed to make your presentation, and any additional packages needed will be installed automatically by instructions in the Dockerfile.

Requirements

• Access to a *NIX system (GNU/Linux or macOS) or knowledge of how to use CLI tools on Windows
• git
• Docker (and Docker Compose)
• Some basic knowledge of RStudio

Build information

This presentation is put together using:

• R and RMarkdown, using RStudio
• ggplot2 for the plots + plotly for the interactivity
• knitr (available within RStudio) + reveal.js for the presentation itself
• hypothes.is, which provides the annotation layer on top of the presentation

knitr takes the .Rmd (R Markdown) file and through some wizardry produces a standalone .html file that serves as the presentation.

Workflow

Fire up a terminal, navigate to a directory where you would like to download this repository, and follow these instructions:

$ git clone https://github.com/RaoOfPhysics/contained-revealr.git # Clone this git repo to your machine
$ cd contained-revealr # Enter the git repository
$ docker-compose up -d # Launch the Docker container named amr_research

You then need to navigate you localhost:8787 or 0.0.0.0:8787 in your browser, to see RStudio along with all the files from the repository. To log in, use "rstudio" as both the username and password.

When you're done playing around with the RStudio, close your browser window, and run:

$ docker-compose down # Will stop and delete the container
# Optional! If you want to delete the Docker image just created,
# run the following command as well:
$ docker image rm raoofphysics/contained-revealr

Contributing

Feel free to submit a pull request with your proposed changes or create an issue on GitHub.

Licence

Contained revealR by Achintya Rao is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.