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

datarobot (version 2.15.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

471

Version

2.15.0

License

MIT + file LICENSE

Maintainer

David Chudzicki

Last Published

November 18th, 2019

Functions in datarobot (2.15.0)

BlueprintChartToGraphviz

Convert a blueprint chart into graphviz DOT format
ConstructDurationString

Construct a valid string representing a duration in accordance with ISO8601
BlendMethods

Blend methods
AutopilotMode

Autopilot modes
CleanServerData

Reformat paginated data returned from the server.
CreateRandomPartition

Create a random 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
CreateDerivedFeatures

Derived Features
AddEureqaSolution

Add a Eureqa solution to the list of models for the project.
ApplySchema

Apply a schema to DataRobot objects (lists, frames)
CreateFeaturelist

Create a new featurelist in a DataRobot project
CreateGroupPartition

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

This function allows the user to create a new featurelist in a project by specifying its name and a list of variables to be included
CreateBacktestSpecification

Create a list describing backtest parameters
CreateDataSource

Create a data source.
CreateComplianceDocumentation

Create compliance documentation from a model.
CreateCalendar

Create a calendar from an uploaded CSV.
DeleteComplianceDocTemplate

Deletes a compliance doc template.
DeleteDataSource

Delete a data store.
DeleteModelJob

Delete a model job from the modeling queue
DataPartition

Data Partition methods
DeleteModelingFeaturelist

Delete a modeling featurelist
CrossValidateModel

Run cross validation on a model.
DownloadRatingTable

Download a rating table to a CSV.
DeletePredictJob

Function to delete one predict job from the DataRobot queue
CreateDataStore

Create a data store.
DeletePredictionDataset

Delete a specified prediction dataset
DownloadScoringCode

Download scoring code JAR
CreateUserPartition

Create a class partition object for use in the SetTarget function representing a user-defined partition.
DownloadComplianceDocTemplate

Download a compliance doc template (in JSON format).
ExpectHasKeys

Make sure that the object has all of the keys specified. Also tests that there are not additional keys if allowAdditional is FALSE (default).
FeatureFromAsyncUrl

Retrieve a feature from the creation URL
DeleteTransferrableModel

Delete this imported model.
DataPathFromDataArg

Get the data path.
DeletePredictionExplanations

Function to delete prediction explanations
DeletePredictionExplanationsInitialization

Delete the prediction explanations initialization for a model.
GetBlueprintChart

Retrieve a blueprint chart
GetBlueprintDocumentation

Get documentation for tasks used in the blueprint
DeleteCalendar

Delete a calendar
DeleteFeaturelist

Delete a featurelist
DeleteDataStore

Delete a data store.
DataSubset

Data subset for training predictions
DifferencingMethod

Differencing method
GetFeatureInfo

Details about a feature
GetFeatureImpactForModel

Retrieve completed Feature Impact results given a model
CreateDatetimePartitionSpecification

Create a list describing datetime partition parameters
DownloadComplianceDocumentation

Download compliance documentation (in DOCX format).
CreateStratifiedPartition

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

Cancel a running job
CreateRatingTable

Creates and validates a new rating table from an uploaded CSV.
DeleteModel

Delete a specified DataRobot model
DownloadPredictionExplanations

Function to download and save prediction explanations rows as csv file
DeleteProject

Delete a specified element from the DataRobot project list
DeleteTransferableModel

Delete this imported model.
DownloadPrimeCode

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

Download an transferable model file for use in an on-premise DataRobot standalone prediction environment.
GenerateDatetimePartition

Preview the full partitioning determined by a DatetimePartitioningSpecification
GetFrozenModelFromJobId

Retrieve a frozen model defined by modelJobId
GetDataStoreSchemas

Get the schemas associated with a data store.
DownloadTimeSeriesFeatureDerivationLog

Download the time series feature derivation log as a text file.
GetDataStore

Returns information about a particular data store.
DownloadTrainingPredictions

Download training predictions on a specified data set.
GetDriver

Returns information about a particular driver.
GetBlenderModelFromJobId

Retrieve a new or updated blender model defined by modelJobId
GetFeatureHistogram

Retrieve histogram plot data for a specific feature
GetBlueprint

Retrieve a blueprint
GetComplianceDocTemplate

Get a compliance doc template.
GetConfusionChart

Retrieve a model's confusion chart for a specified source.
GetBlenderModel

Retrieve the details of a specified blender model
GetDataSource

Returns information about a particular data source.
GetFeatureImpactForJobId

Retrieve completed Feature Impact results given a job ID
GetCrossValidationScores

Get cross validation scores
GetFeatureImpact

Get the feature impact for a model, requesting the feature impact if it is not already available.
GetLiftChart

Retrieve lift chart data for a model for a data partition (see DataPartition)
GetPredictJobs

Function to list all prediction jobs in a project
GetPredictJob

Request information about a predict job
GetJob

Request information about a job
GetGeneralizedInsight

An internal function to help fetch insights.
DownloadTransferrableModel

Download an transferrable model file for use in an on-premise DataRobot standalone prediction environment.
GetDatetimeModelFromJobId

Retrieve a new or updated datetime model defined by modelJobId
GetCalendar

Retrieve a calendar
GetRatingTableModelFromJobId

Retrieve a new or updated rating table model defined by a job ID.
GetRatingTableModel

Retrieve information about specified model with a rating table.
GetPredictionExplanationsRows

Retrieve all prediction explanations rows
GetPredictionExplanationsRowsAsDataFrame

Retrieve all prediction explanations rows and return them as a data frame
GetTrainingPredictionDataFrame

Simplify the training prediction rows into a tidy format dataframe.
GetWordCloud

Retrieve word cloud data for a model.
GetValidMetrics

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

Returns a dataframe with information on available data stores.
GetTimeSeriesFeatureDerivationLog

Retrieve the time series feature derivation log content
GetDatetimePartition

Retrieve the DatetimePartitioning from a project
GetModelRecommendation

Retrieve a model recommendation from DataRobot for your project.
GetModelBlueprintChart

Retrieve a model blueprint chart
GetTrainingPredictionsFromJobId

Retrieve the training predictions for a model using a job id.
GetRatingTable

Retrieve a single rating table.
GetPredictionExplanationsInitialization

Retrieve the prediction explanations initialization for a model.
GetModelingFeaturelist

Retrieve a specific modeling featurelist from a DataRobot project
GetPredictionExplanationsInitializationFromJobId

Retrieve the prediction explanations initialization for a model using jobId
GetRatingTableFromJobId

Get a rating table from the rating table job metadata.
GetTransferableModel

Retrieve imported model info using import id
IsBlenderEligible

Check whether individual models can be blended together
GetMissingValuesReport

Get a report on missing values for the model.
GetFrozenModel

Retrieve the details of a specified frozen model
GetModelJob

Request information about a single model job
GetCalendarFromProject

Retrieve the calendar for a particular project.
GetFeaturelist

Retrieve a specific featurelist from a DataRobot project
GetDataStoreTables

Get all tables associated with a data store.
GetModelParameters

Retrieve model parameters
GetPredictionDataset

Retrieve data on a prediction dataset
GetDatetimeModel

Retrieve the details of a specified datetime model.
GetPredictionExplanations

Get prediction explanations
IsId

Checks if an id is a valid DataRobot ID (24 character string)
ListTransferrableModels

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

Periodicity time units
RequestFrozenDatetimeModel

Train a new frozen datetime model with parameters from the specified model
ListModelRecommendations

Retrieve information about model recommendation made by DataRobot for your project.
ListModelingFeaturelists

Retrieve all modeling featurelists associated with a project
ListDrivers

Returns a dataframe with information on available drivers.
MakeDataRobotRequest

Make a HTTP request
PostgreSQLdrivers

PostgreSQL drivers
GetModelBlueprintDocumentation

Get documentation for tasks used in the model blueprint
GetMultiSeriesProperties

Retrieve time series properties for a potential multiseries datetime partition column
GetModel

Retrieve the details of a specified model
SetPredictionThreshold

Set a custom prediction threshold for binary classification models.
RequestTrainingPredictions

Request training predictions for a specific model.
RequestFrozenModel

Train a new frozen model with parameters from specified model
RequestSampleSizeUpdate

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

Get supported capabilities for a model, e.g., whether it has a word cloud.
GetPredictionExplanationsMetadataFromJobId

Retrieve the prediction explanations metadata for a model using jobId
GetModelFromJobId

Retrieve a new or updated model defined by modelJobId
GetPredictionExplanationsMetadata

Retrieve metadata for specified prediction explanations
GetPrimeModel

Retrieve information about specified DataRobot Prime model.
SetTarget

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

Retrieve information about specified DataRobot Prime model using corresponding jobId.
GetPredictions

Retrieve model predictions
GetPrimeEligibility

Check if model can be approximated with DataRobot Prime
GetParetoFront

Pareto Front data for a Eureqa model
GetPrimeFile

Retrieve a specific Prime file from a DataRobot project
ListModels

Retrieve all available model information for a DataRobot project
ListPredictionDatasets

Retrieve all prediction datasets associated with a project
ListJobs

Retrieve information about jobs
ListLiftCharts

Retrieve lift chart data for a model for all available data partitions (see DataPartition)
GetProject

Retrieve details about a specified DataRobot modeling project
ListRatingTables

Retrieve information about all rating tables.
GetRecommendedModel

Retrieve the model object that DataRobot recommends for your project.
ProjectStage

Project stage
ListRocCurves

Retrieve ROC curve data for a model for all available data partitions (see DataPartition)
RecommendedModelType

Recommended model type values
SetupProjectFromPostgreSQL

Function to set up a new DataRobot project using data from PostgreSQL table (deprecated)
ToggleStarForModel

Star a model if it is unstarred, otherwise unstar the model.
SetupProjectFromOracle

Function to set up a new DataRobot project using data from Oracle table (deprecated)
UpdateCalendar

Update a calendar
UpdateComplianceDocTemplate

Update the name or sections of an existing doc template.
TreatAsExponential

Treat as exponential
ValidateModel

Validate that model belongs to class 'dataRobotModel' and includes projectId and modelId.
GetRocCurve

Retrieve ROC curve data for a model for a particular data partition (see DataPartition)
RequestCrossSeriesDetection

Format a cross series with group by columns.
IsParameterIn

Check if a parameter is in a list of possibilities.
ValidateMultiSeriesProperties

Validate that the multiseries properties indicate a successful multiseries setup.
WaitForAutopilot

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

Retrieve a DataRobot web page that displays detailed project information
ListPredictionExplanationsMetadata

Retrieve metadata for prediction explanations in specified project
ListComplianceDocTemplates

Retrieve information about all compliance doc templates.
ListCalendars

List all available calendars.
JobStatus

Job statuses
GetProjectStatus

Request Autopilot status for a specified DataRobot project
GetTrainingPredictions

Retrieve training predictions on a specified data set.
GetPrimeFileFromJobId

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

Get training predictions for a particular model.
GetRulesets

List the rulesets approximating a model generated by DataRobot Prime
GetServerDataInRows

Handle server side pagination.
ListPredictions

Fetch all computed predictions for a project.
JobType

Job type
ListFeatureInfo

Details about all features for this project
ListBlueprints

Retrieve the list of available blueprints for a project
ListProjects

Retrieve a list of all DataRobot projects
ListPrimeFiles

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

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

Retrieve all featurelists associated with a project
ListRatingTableModels

Retrieve information about all DataRobot models with a rating table.
RequestFeatureImpact

Request Feature Impact to be computed.
ListSharingAccess

List information about which users have what kinds of access to a shared object.
RequestNewModel

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

Retrieve imported model info using import id
ListTrainingPredictions

Retrieve information about all training prediction datasets in a project.
ListModelFeatures

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

Retrieve data on tuning parameters for a particular model.
ListDataSources

Returns a dataframe with information on available data sources.
ListModelJobs

Retrieve status of Autopilot modeling jobs that are not complete
ListTransferableModels

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

Create a new model from a rating table.
ListConfusionCharts

Returns all available confusion charts for the model.
StartTuningSession

Create a function to initiate hyperparameter tuning for a particular model.
PrimeLanguage

Prime Language
ScoreBacktests

Compute the scores for all available backtests.
SeriesAggregationType

Series aggregation type
PauseQueue

Pause the DataRobot modeling queue
ListStarredModels

List all the starred models in a project.
ProjectFromAsyncUrl

Retrieve a project from the project-creation URL
ReformatMetrics

replace NULL in $metrics list elements with NA
RenameRatingTable

Renames a rating table to a different name.
Stringify

Convert a function into a single string for DataRobot
RequestPredictions

Request predictions against a previously uploaded dataset
PeriodicityMaxTimeStep

Periodicity max time step
TestDataStore

Test the database connection to the data store.
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.
RequestBlender

Submit a job for creating blender model. Upon success, the new job will be added to the end of the queue.
Predict

Retrieve model predictions
RequestTransferableModel

Request generation of an transferable 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 DownloadTransferableModel for that.
RequestApproximation

Request an approximation of a model using DataRobot Prime
PredictionDatasetFromAsyncUrl

Retrieve prediction dataset info from the dataset creation URL
RequestNewDatetimeModel

Adds a new datetime model of the type specified by the blueprint to a DataRobot project
RequestMultiSeriesDetection

Format a multiseries.
RequestPrimeModel

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

Request prediction explanations initialization for specified model
RunInteractiveTuning

Run an interactive model tuning session.
RequestPredictionExplanations

Request prediction explanations computation for a specified model and dataset.
SetupProject

Function to set up a new DataRobot project
TimeUnits

Time units
UpdateDataSource

Update a data store.
SetupProjectFromDataSource

Create a project from a data source.
UpdateDataStore

Update a data store.
UnstarModel

Unstar a model.
UpdateModelingFeaturelist

Update a modeling featurelist
UpdateFeaturelist

Update a featurelist
ScaleoutModelingMode

Scaleout modeling modes
ValidateParameterIn

Ensure a parameter is valid
Share

Share a shareable object with a particular user.
UpdateAccess

Update access to a particular object.
SharingRole

Sharing role
SetupProjectFromHDFS

Function to set up a new DataRobot project using datasource on a WebHDFS server (deprecated)
UploadTransferrableModel

Import a previously exported model for predictions.
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.
TargetType

Target Type modes
ValidateProject

Get a projectId from a project object.
UpdateTransferableModel

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

Star a model.
UploadData

Upload a data source.
UploadPredictionDataset

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

Target leakage report values
UpdateProject

Update parameters for an existing project
ValidatePartition

Checks if a partition is valid.
ValidateCalendar

Get a calendar id from a calendar object.
cvMethods

CV methods
SetupProjectFromMySQL

Function to set up a new DataRobot project using data from MySQL table (deprecated)
datarobot-package

datarobot: 'DataRobot' Predictive Modeling API
StartProject

Start a project, set the target, and run autopilot.
ViewWebModel

Retrieve a DataRobot web page that displays detailed model information
as.data.frame

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

Wait for specified job to complete
UnpauseQueue

Re-start the DataRobot modeling queue
UploadComplianceDocTemplate

Upload a compliance doc template.
StartRetryWaiter

Creates a waiter function that can be used in a loop while trying some task many times. The waiter sleeps while waiting to try again, with sleep times determined by exponential back-off.
UploadTransferableModel

Import a previously exported model for predictions.
TryingToSubmitNull

Checks to see if we are trying to submit `NULL` as a value.
UpdateTransferrableModel

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

Upload a prediction dataset from a data source.
plot.listOfModels

Plot method for DataRobot S3 objects of class listOfModels
predict.dataRobotModel

Retrieve model predictions using R's default S3 predict method.
summary.dataRobotModel

DataRobot S3 object methods for R's generic summary function
summary.listOfDataRobotTuningParameters

Summarize the list of tuning parameters available for a model.
ConnectToDataRobot

Establish a connection to the DataRobot modeling engine