After creating a Plumber file with vetiver_write_plumber()
, use
vetiver_write_docker()
to create a Dockerfile plus a vetiver_renv.lock
file for a pinned vetiver_model()
.
Arguments
- vetiver_model
A deployable
vetiver_model()
object- plumber_file
A path for your Plumber file, created via
vetiver_write_plumber()
. Defaults toplumber.R
in the working directory.- path
A path to write the Dockerfile and
lockfile
, capturing the model's package dependencies. Defaults to the working directory.- ...
Not currently used.
- lockfile
The generated lockfile in
path
. Defaults to"vetiver_renv.lock"
.- rspm
A logical to use the RStudio Public Package Manager for
renv::restore()
in the Docker image. Defaults toTRUE
.- base_image
The base Docker image to start with. Defaults to
rocker/r-ver
for the version of R you are working with, but models like keras will require a different base image.- port
The server port for listening: a number such as 8080 or an expression like
'as.numeric(Sys.getenv("PORT"))'
when the port is injected as an environment variable.- expose
Add
EXPOSE
to the Dockerfile? This is helpful for using Docker Desktop but does not work with an expression forport
.- additional_pkgs
A character vector of additional package names to add to the Docker image. For example, some boards like
pins::board_s3()
require additional software; you can userequired_pkgs(board)
here.
Examples
library(pins)
tmp_plumber <- tempfile()
b <- board_temp(versioned = TRUE)
cars_lm <- lm(mpg ~ ., data = mtcars)
v <- vetiver_model(cars_lm, "cars_linear")
vetiver_pin_write(b, v)
#> Creating new version '20241009T170847Z-7301a'
#> Writing to pin 'cars_linear'
vetiver_write_plumber(b, "cars_linear", file = tmp_plumber)
## default port
vetiver_write_docker(v, tmp_plumber, tempdir())
#> The following required packages are not installed:
#> - cpp11 [required by lobstr, readr, tzdb, and 1 other]
#> Consider reinstalling these packages before snapshotting the lockfile.
#>
#> - The lockfile is already up to date.
## install more pkgs, like those required to access board
vetiver_write_docker(v, tmp_plumber, tempdir(),
additional_pkgs = required_pkgs(b))
#> The following required packages are not installed:
#> - cpp11 [required by lobstr, readr, tzdb, and 1 other]
#> Consider reinstalling these packages before snapshotting the lockfile.
#>
#> - The lockfile is already up to date.
## port from env variable
vetiver_write_docker(v, tmp_plumber, tempdir(),
port = 'as.numeric(Sys.getenv("PORT"))',
expose = FALSE)
#> The following required packages are not installed:
#> - cpp11 [required by lobstr, readr, tzdb, and 1 other]
#> Consider reinstalling these packages before snapshotting the lockfile.
#>
#> - The lockfile is already up to date.