Learn R Programming
⚠️There's a newer version (2.18.6) of this package.Take me there.

datarobot (version 2.4.0)

DataRobot Predictive Modeling API

Description

For working with the DataRobot predictive modeling platform's API.

Copy Link

Version

Install

install.packages('datarobot')

Monthly Downloads

390

Version

2.4.0

License

MIT + file LICENSE

Maintainer

David Chudzicki

Last Published

December 1st, 2016

Functions in datarobot (2.4.0)

CreateDerivedFeatures

Derived Features
CreateStratifiedPartition

Create a stratified sampling-based S3 object of class partition for the SetTarget function
CreatePrimeCode

Create and validate the downloadable code for the ruleset associated with this model
CreateGroupPartition

Create a group-based S3 object of class partition for the SetTarget function
CreateFeaturelist

Create a new featurelist in a DataRobot project
as.data.frame

DataRobot S3 object methods for R's generic as.data.frame function
CreateUserPartition

Create a user-defined S3 object of class partition for the SetTarget function
ConnectToDataRobot

Establish a connection to the DataRobot modeling engine
AutopilotMode

Autopilot modes
DownloadPrimeCode

Download the code of DataRobot Prime model and save it to a file
DeletePredictionDataset

Delete a specified prediction dataset
datarobot-package

DataRobot Predictive Modeling API
DeleteJob

Cancel a running job
DeletePredictJob

Function to delete one predict job from the DataRobot queue
DeleteModel

Delete a specified DataRobot model
DeleteModelJob

Delete a model job from the modeling queue
DownloadTransferrableModel

Download an transferrable model file for use in an on-premise DataRobot standalone prediction environment. This function can only be used if model export is enabled, and will only be useful if you have an on-premise environment in which to import it.
DeleteTransferrableModel

Delete this imported model.
DeleteProject

Delete a specified element from the DataRobot project list
GetFeatureInfo

Details about a feature
GetModelFromJobId

Retrieve a new or updated model defined by modelJobId
GetFeaturelist

Retrieve a specific featurelist from a DataRobot project
GetProjectList

Retrieve a list of all DataRobot projects
GetProject

Retrieve dtails about a specified DataRobot modeling project
GetModelJobs

Retrieve status of Autopilot modeling jobs that are not complete
GetPrimeFile

Retrieve a specific Prime file from a DataRobot project
GetFeatureImpactForModel

Retrieve completed Feature Impact results given a model
GetFeatureImpactForJobId

Retrieve completed Feature Impact results given a job ID
GetPrimeFileFromJobId

Retrieve a specific Prime file from a DataRobot project for corresponding jobId
GetRulesets

List the rulesets approximating a model generated by DataRobot Prime
GetTransferrableModel

Retrieve imported model info using import id
GetModelObject

Retrieve the details of a specified model
GetPredictions

Retrieve model predictions from predictJobId
GetPrimeEligibility

Check if model can be approximated with DataRobot Prime
GetPredictJobs

Function to list all prediction jobs in a project
ListFeaturelists

Retrieve all featurelists associated with a project
ListFeatureInfo

Details about all features for this project
PrimeLanguage

Prime Language
ProjectFromAsyncUrl

Retrieve a project from the project-creation URL
ListPredictionDatasets

Retrieve all prediction datasets associated with a project
SetTarget

Set the target variable (and by default, start the DataRobot Autopilot)
ListPrimeFiles

List all downloadable code files from DataRobot Prime for the project
RequestPredictionsForDataset

Request predictions against a previously uploaded dataset
RequestPrimeModel

Request training for a DataRobot Prime model using a specified ruleset
SetupProject

Function to set up a new DataRobot project
GetAllModels

Retrieve all available model information for a DataRobot project
FeatureFromAsyncUrl

Retrieve a feature from the creation URL
GetPrimeModel

Retrieve information about specified DataRobot Prime model
GetValidMetrics

Retrieve the valid fitting metrics for a specified project and target
GetPrimeModelFromJobId

Retrieve information about specified DataRobot Prime model using corresponding jobId
ListPrimeModels

Retrieve information about all DataRobot Prime models for a DataRobot project
JobStatus

Job statuses
SetupProjectFromPostgreSQL

Function to set up a new DataRobot project using data from PostgreSQL table
ListTransferrableModels

Retrieve information about all imported models This function returns a data.frame that describes all imported models
SetupProjectFromOracle

Function to set up a new DataRobot project using data from Oracle table
GetProjectStatus

Request Autopilot status for a specified DataRobot project
GetRecommendedBlueprints

Retrieve the list of available blueprints for a project
ListJobs

Retrieve information about jobs
ListModelFeatures

Returns the list of features (i.e., variables) on which a specified model is based
PostgreSQLdrivers

PostgreSQL drivers
PredictionDatasetFromAsyncUrl

Retrieve prediction dataset info from the dataset creation URL
RequestNewModel

Adds a new model of type specified by blueprint to a DataRobot project
UploadPredictionDataset

Function to upload new data to a DataRobot project for predictions
RequestPredictions

Request predictions for model from newdata
UpdateTransferrableModel

Update the display name or note for an imported model.
SetupProjectFromHDFS

Function to set up a new DataRobot project using datasource on a WebHDFS server
SetupProjectFromMySQL

Function to set up a new DataRobot project using data from MySQL table
JobType

Job type
ListBlueprints

Retrieve the list of available blueprints for a project
PauseQueue

Pause the DataRobot modeling queue
plot.listOfModels

Plot method for DataRobot S3 objects of class listOfModels
RequestFeatureImpact

Request Feature Impact to be computed.
RequestApproximation

Request an approximation of a model using DataRobot Prime
StartNewAutoPilot

Starts autopilot on provided featurelist. Only one autopilot can be running at the time. That's why any ongoing autopilot on different featurelist will be halted - modelling jobs in queue would not be affected but new jobs would not be added to queue by halted autopilot.
summary.dataRobotModel

DataRobot S3 object methods for R's generic summary function
ViewWebModel

Retrieve a DataRobot web page that displays detailed model information
UploadTransferrableModel

Import a previously exported model for predictions.
ViewWebProject

Retrieve a DataRobot web page that displays detailed project information
WaitForAutopilot

This function periodically checks whether Autopilot is finished and returns only after it is.
WaitForJobToComplete

Wait for specified job to complete
RequestSampleSizeUpdate

Refits an existing model to a different fraction of the training dataset
RequestTransferrableModel

Request generation of an transferrable model file for use in an on-premise DataRobot standalone prediction environment. This function can only be used if model export is enabled, and will only be useful if you have an on-premise environment in which to import it. This function does not download the exported file. Use DownloadTransferrableModel for that. Example: jobId<-RequestTransferrrableModel(projectObject, modelId) WaitForJobToComplete(projectObject, jobId) DownloadTransferrableModel(projectObject, modelId, file)
UnpauseQueue

Re-start the DataRobot modeling queue
CreateRandomPartition

Create a random sampling-based S3 object of class partition for the SetTarget function
UpdateProject

Update parameters for an existing project