Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ThinkR-open/dockerfiler
Easy Dockerfile Creation from R
https://github.com/ThinkR-open/dockerfiler
golemverse hacktoberfest hacktoberfest-accepted
Last synced: 3 months ago
JSON representation
Easy Dockerfile Creation from R
- Host: GitHub
- URL: https://github.com/ThinkR-open/dockerfiler
- Owner: ThinkR-open
- License: other
- Created: 2018-02-04T22:22:00.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-27T10:03:18.000Z (9 months ago)
- Last Synced: 2024-04-16T06:03:04.686Z (7 months ago)
- Topics: golemverse, hacktoberfest, hacktoberfest-accepted
- Language: R
- Homepage: https://thinkr-open.github.io/dockerfiler/
- Size: 532 KB
- Stars: 160
- Watchers: 7
- Forks: 23
- Open Issues: 24
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - ThinkR-open/dockerfiler - Easy Dockerfile Creation from R (R)
README
---
output: github_document
---
```{r setup, include = FALSE}
knitr::opts_chunk$set(
eval = FALSE,
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
[](https://github.com/ThinkR-open/dockerfiler/actions)
[](https://codecov.io/github/ThinkR-open/dockerfiler?branch=master)
# `{dockerfiler}`
The goal of `{dockerfiler}` is to provide an easy way to create Dockerfiles from R.
## About
You're reading the doc about version :
```{r eval = TRUE}
desc::desc_get_version()
```
The check results are:
```{r eval = TRUE}
devtools::check(quiet = TRUE)
```
## Installation
You can install dockerfiler from GitHub with:
```{r gh-installation, eval = FALSE}
# install.packages("remotes")
remotes::install_github("ThinkR-open/dockerfiler")
```
Or from CRAN with :
```{r, eval = FALSE}
install.packages("dockerfiler")
```
## Basic worflow
By default, Dockerfiles are created with `FROM "rocker/r-base"`.
You can set another FROM in `new()`
```{r}
library(dockerfiler)
# Create a dockerfile template
my_dock <- Dockerfile$new()
my_dock$MAINTAINER("Colin FAY", "[email protected]")
```
Wrap your raw R Code inside the `r()` function to turn it into a bash command with `R -e`.
```{r}
my_dock$RUN(r(install.packages("attempt", repo = "http://cran.irsn.fr/")))
```
Classical Docker stuffs:
```{r}
my_dock$RUN("mkdir /usr/scripts")
my_dock$RUN("cd /usr/scripts")
my_dock$COPY("plumberfile.R", "/usr/scripts/plumber.R")
my_dock$COPY("torun.R", "/usr/scripts/torun.R")
my_dock$EXPOSE(8000)
my_dock$CMD("Rscript /usr/scripts/torun.R ")
```
See your Dockerfile :
```{r}
my_dock
```
If you've made a mistake in your script, you can switch lines with the `switch_cmd` method. This function takes as arguments the positions of the two cmd you want to switch :
```{r}
# Switch line 8 and 7
my_dock$switch_cmd(8, 7)
my_dock
```
You can also remove a cmd with `remove_cmd`:
```{r}
my_dock$remove_cmd(8)
my_dock
```
This also works with a vector:
```{r}
my_dock$remove_cmd(5:7)
my_dock
```
`add_after` add a command after a given line.
```{r}
my_dock$add_after(
cmd = "RUN R -e 'remotes::install_cran(\"rlang\")'",
after = 3
)
```
Save your Dockerfile:
```{r eval = FALSE}
my_dock$write()
```
## Create a Dockerfile from a DESCRIPTION
You can use a DESCRIPTION file to create a Dockerfile that installs the dependencies and the package.
```{r}
my_dock <- dock_from_desc("DESCRIPTION")
my_dock
my_dock$CMD(r(library(dockerfiler)))
my_dock$add_after(
cmd = "RUN R -e 'remotes::install_cran(\"rlang\")'",
after = 3
)
my_dock
```
## Create a Dockerfile from renv.lock
- Create renv.lock
```{r, message=FALSE, results='hide'}
dir_build <- tempfile(pattern = "renv")
dir.create(dir_build)
# Create a lockfile
the_lockfile <- file.path(dir_build, "renv.lock")
custom_packages <- c(
# attachment::att_from_description(),
"renv",
"cli",
"glue",
"golem",
"shiny",
"stats",
"utils",
"testthat",
"knitr"
)
renv::snapshot(
packages = custom_packages,
lockfile = the_lockfile,
prompt = FALSE
)
```
- Build Dockerfile
```{r}
my_dock <- dock_from_renv(
lockfile = the_lockfile,
distro = "focal",
FROM = "rocker/verse"
)
my_dock
```
## Contact
Questions and feedbacks [welcome](mailto:[email protected])!
You want to contribute ? Open a [PR](https://github.com/ThinkR-open/dockerfiler/pulls) :) If you encounter a bug or want to suggest an enhancement, please [open an issue](https://github.com/ThinkR-open/dockerfiler/issues).
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
By participating in this project you agree to abide by its terms.