deploy: Deploy QBit Workspace

In quantargo/qbit: A new way to build and share your data science projects

Deploy QBit Workspace

Description

QBit workspaces can be deployed with a (pre-existing) qbit_id and a specified main_file containing the source code of a qbit. Additional files containing, e.g. data are included through the files parameter.

Usage

deploy(
  qbit_id,
  main_file = empty_main_file(extension = "R"),
  files = NULL,
  index = NULL,
  meta = NULL,
  source_main_file = TRUE,
  eval_env = .GlobalEnv,
  obj = ls(envir = eval_env),
  timeout = 120,
  package_lock = "renv.lock",
  packagesLoaded = dependencies()$Package,
  apikey = getOption("QKEY"),
  usagePlan = "public",
  url = getOption("QBITURL", "https://api.quantargo.com/v2"),
  verbose = getOption("verbose"),
  tmpdir = tempdir(),
  secrets = NULL,
  runtime = "R"
)

Arguments

qbit_id	character; Name of the QBit function.
main_file	character; Main file (either main.R or main.Rmd) to be used for QBit.
files	character; Files to be part of Qbit
index	list; Index meta data for qbit
meta	list; Meta data of the QBit object.
source_main_file	character; Specify if file shall be sourced before uploading. This setting can be helpful to create the required environment.
eval_env	environment; Environment from which R objects shall be taken
obj	character; Names of objects to be included into qbit environment
timeout	numeric; QBit timeout in seconds.
package_lock	character; Package lock file
packagesLoaded	character; Packages namespaces to be loaded (through library)
apikey	character; API Key used to invoke QBit API endpoint. After creating an account at https://www.quantargo.com the API key is available in the user settings https://www.quantargo.com/dashboard.
usagePlan	character; Usage plan of Qbit, can be either either public or private.
url	character; Upload url to be used
verbose	logical; Specify if output shall be shown
tmpdir	character; Temporary directory to be used for qbit/zip creation.
secrets	list; List of provided secrets to be used for workspace.
runtime	character; Runtime to be used for QBit, either "R" or "Python"

Examples

## Not run: 
  deploy('qbit-example-landing-page', main_file = 'main.R')
  deploy("qbit-tidymodels-model-selection-used-cars",
         main_file = "main.Rmd",
         files = c("README.md",
                   "dt_tuned.rds",
                   "rf_tuned.rds",
                   "audi.csv"),
         index = yaml::read_yaml("index.yml"),
         meta = list(type="qbit"),
         timeout = 300)

## End(Not run)

quantargo/qbit documentation built on March 20, 2022, 10:35 a.m.