vetiver_deploy_rsconnect: Deploy a vetiver model API to RStudio Connect

In tidymodels/vetiver: Version, Share, Deploy, and Monitor Models

Deploy a vetiver model API to RStudio Connect

Description

Use vetiver_deploy_rsconnect() to deploy a vetiver_model() that has been versioned and stored via vetiver_pin_write() as a Plumber API on RStudio Connect.

Usage

vetiver_deploy_rsconnect(
  board,
  name,
  version = NULL,
  predict_args = list(),
  appTitle = glue::glue("{name} model API"),
  ...
)

Arguments

board	A pin board, created by board_folder(), board_connect(), board_url() or another board_ function.
name	Pin name.
version	Retrieve a specific version of a pin. Use pin_versions() to find out which versions are available and when they were created.
predict_args	A list of optional arguments passed to vetiver_api() such as the prediction type.
appTitle	The API title on RStudio Connect. Use the default based on name, or pass in your own title.
...	Other arguments passed to rsconnect::deployApp() such as account or launch.browser.

Details

The two functions vetiver_deploy_rsconnect() and vetiver_create_rsconnect_bundle() are alternatives to each other, providing different strategies for deploying a vetiver model API to RStudio Connect.

Value

The deployment success (TRUE or FALSE), invisibly.

See Also

vetiver_write_plumber(), vetiver_create_rsconnect_bundle()

Examples

library(pins)
b <- board_temp(versioned = TRUE)
cars_lm <- lm(mpg ~ ., data = mtcars)
v <- vetiver_model(cars_lm, "cars_linear")
vetiver_pin_write(b, v)

if (FALSE) {
## pass args for predicting:
vetiver_deploy_rsconnect(
    b,
    "user.name/cars_linear",
    predict_args = list(debug = TRUE)
)

## specify an account name through `...`:
vetiver_deploy_rsconnect(
    b,
    "user.name/cars_linear",
    account = "user.name"
)
}

tidymodels/vetiver documentation built on May 27, 2023, 8:18 p.m.