https://github.com/analythium/rmarkdown-docker-examples
R Markdown Examples with Docker
https://github.com/analythium/rmarkdown-docker-examples
Last synced: 5 months ago
JSON representation
R Markdown Examples with Docker
- Host: GitHub
- URL: https://github.com/analythium/rmarkdown-docker-examples
- Owner: analythium
- License: mit
- Created: 2022-07-07T22:17:24.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-26T02:16:33.000Z (over 2 years ago)
- Last Synced: 2024-08-09T02:19:49.040Z (8 months ago)
- Size: 397 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - analythium/rmarkdown-docker-examples - R Markdown Examples with Docker (Others)
README
# R Markdown Examples with Docker
This repository contains code for the blog post [Containerizing Interactive R Markdown Documents](https://hosting.analythium.io/containerizing-interactive-r-markdown-documents/) from the _Hosting Data Apps_ website -- [hosting.analythium.io](https://hosting.analythium.io/).
## Runtime: shiny
Read [Introduction to interactive documents](https://shiny.rstudio.com/articles/interactive-docs.html) for details on this runtime.
```bash
docker build -f Dockerfile.shiny -t psolymos/rmd:shiny .
docker run -p 8080:3838 psolymos/rmd:shiny
```
## Runtime: shinyrmd
> The runtime `shinyrmd` was introduced in [rmarkdown version 2.5](https://rmarkdown.rstudio.com/docs/news/index.html#rmarkdown-25) as an alias for the runtime `shiny_prerendered`.
Read [Prerendered Shiny documents](https://rmarkdown.rstudio.com/authoring_shiny_prerendered.HTML) for details on this runtime.
```bash
docker build -f Dockerfile.shinyrmd -t psolymos/rmd:shinyrmd .
docker run -p 8080:3838 psolymos/rmd:shinyrmd
```
The [learnr](https://CRAN.R-project.org/package=learnr) R package is for creating interactive tutorials using R Markdown. It also uses the prerendered Shiny runtime, so here is an [example](https://github.com/rstudio/learnr/blob/main/inst/tutorials/ex-setup-r/ex-setup-r.Rmd):
```bash
docker build -f Dockerfile.learnr -t psolymos/rmd:learnr .
docker run -p 8080:3838 psolymos/rmd:learnr
```
## Runtime: static
One option is to render the HTML output locally and copy all these static assets into an Nginx image:
```dockerfile
FROM nginx:alpine
COPY runtime-static /usr/share/nginx/html
CMD ["nginx", "-g", "daemon off;"]
```
This implies that you have all the necessary tools installed on your local machine.
Alternatively, you can use [multi-stage build](https://docs.docker.com/develop/develop-images/multistage-build/) to keep your image size small:
```bash
docker build -f Dockerfile.static -t psolymos/rmd:static .
docker run -p 8080:80 psolymos/rmd:static
```
Another option is to use the static mode of the [of-watchdog](https://github.com/openfaas/of-watchdog) from the [OpenFaaS](https://www.openfaas.com/) project.
> The of-watchdog implements a HTTP server listening on port 8080, and acts as a reverse proxy for running functions and microservices. It can be used independently, or as the entrypoint for a container with OpenFaaS.
```bash
docker build -f Dockerfile.static2 -t psolymos/rmd:static2 .
docker run -p 8080:8080 psolymos/rmd:static2
```
Let's compare the image sizes:
```bash
docker image ls psolymos/rmd --format "{{.Repository}}\t{{.Tag}}\t{{.Size}}"
# psolymos/rmd static2 32.7MB
# psolymos/rmd static 24.3MB
# psolymos/rmd shinyrmd 1.06GB
# psolymos/rmd shiny 1.05GB
```
## License
MIT License (c) 2022 Analythium Solutions Inc.