datarobot (version 2.8.0)

ConnectToDataRobot: Establish a connection to the DataRobot modeling engine

Description

This function initializes a DataRobot session. If a (YAML) config file (with keys for endpoint and token) is placed at $HOME/.config/datarobot/drconfig.yaml, then we attempt to establish a connection to DataRobot when the package loads, so (if successful) this function does not need to be called.

Usage

ConnectToDataRobot(endpoint = NULL, token = NULL, username = NULL,
  password = NULL, userAgentSuffix = NULL, sslVerify = TRUE,
  configPath = NULL)

Arguments

endpoint

character. URL specifying the DataRobot server to be used. It depends on DataRobot modeling engine implementation (cloud-based, on-prem...) you are using. Contact your DataRobot admin for endpoint to use and to turn on API access to your account. The endpoint for DataRobot cloud accounts is https://app.datarobot.com/api/v2

token

character. DataRobot API access token. It is unique for each DataRobot modeling engine account and can be accessed using DataRobot webapp in Account profile section.

username

character. No longer supported.

password

character. No longer supported.

userAgentSuffix

character. Additional text that is appended to the User-Agent HTTP header when communicating with the DataRobot REST API. This can be useful for identifying different applications that are built on top of the DataRobot Python Client, which can aid debugging and help track usage.

sslVerify

logical. Whether to check the SSL certificate. Either TRUE to check (default), FALSE to not check.

configPath

character. Path to YAML config file specifying configuration (token and endpoint).

Details

The function creates the environment variables "DataRobot_URL" and "DataRobot_Token" used by other functions to access the DataRobot modeling engine.

Examples

# NOT RUN {
  ConnectToDataRobot("https://app.datarobot.com/api/v2", "thisismyfaketoken")
  ConnectToDataRobot(configPath = "~/.config/datarobot/drconfig.yaml")
# }