pushFromSource {acumos}R Documentation

Push a component into the Acumos repository from its source file

Description

push pushes a component into the Acumos repository using the component source file (R file).

Usage

pushFromSource(
  url,
  file,
  name = "R Component",
  addSource = TRUE,
  token,
  create = TRUE,
  deploy = FALSE,
  license,
  headers,
  ...
)

Arguments

url

URL for the POST request

file

string, name of component source file (an R script)

name

string, name of the component

addSource

boolean, to add source file to the (ZIP) bundle or not

token

token obtained from auth (optional)

create

logical, isCreateMicroservice parameter. If TRUE the model Docker image is automatically created by the Acumos platform. see Acumos onboarding documentation. See Acumos onboarding documentation.

deploy

logical. If TRUE the model is automatically deployed by the Acumos platform. This parameter cannot take the value TRUE, when the parameter create takes the value FALSE. See Acumos onboarding documentation.

license

optional string, name of a file to supply as the license. If not specified push() will also try to locate a license.json file in the component bundle if present.

headers

optional, named list or named character vector of HTTP headers that are to be added to the request. NOTE: the meaning of optional headers depends on the onboarding server so consult the documentation of the onboarding server for supported additional headers and their meaning.

...

optional, named list or named character vector of HTTP headers that are to be added to the request. NOTE: the meaning of optional headers depends on the onboarding server so consult the documentation of the onboarding server for supported additional headers and their meaning.

Value

invisibly, result of the request (may change in the future)

Note

A regular component source file is an R script in which at least one of the three following functions are defined: acumos_predict, acumos_transform or acumos_fit. They respectively correspond to the functions predict, transform and fit of compose. In that script, if the functions acumos_generate, acumos_service or acumos_initialize are defined, they will also correspond to the other function type arguments of compose, namely generate, service and initialize.

All the R objects defined in that script are included as auxiliary objects that are to be passed to the global workspace of the component. They will fill the aux argument of compose.

See Also

push


[Package acumos version 0.4-4 Index]