datarobot (version 2.18.7)

'DataRobot' Predictive Modeling API

Description

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

Copy Link

Version

Install

install.packages('datarobot')

Monthly Downloads

681

Version

2.18.7

License

MIT + file LICENSE

Maintainer

David Chudzicki

Last Published

October 2nd, 2025

Functions in datarobot (2.18.7)

ConnectToDataRobot

Establish a connection to the DataRobot modeling engine

CreateComplianceDocumentation

Create compliance documentation from a model.

ComputeDatetimeTrendPlots

Compute datetime trend plots for datetime partitioned model.

CreateDatetimePartitionSpecification

Create a list describing datetime partition parameters

ConstructDurationString

Construct a valid string representing a duration in accordance with ISO8601

CreateDataStore

Create a data store.

CreateCalendar

Create a calendar from an uploaded CSV.

CreateDataSource

Create a data source.

CreateBacktestSpecification

Create a list describing backtest parameters

CreateRatingTable

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

CreateUserPartition

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

CrossValidateModel

Run cross validation on a model.

CreateDerivedFeatures

Derived Features

CreateFeaturelist

Create a new featurelist in a DataRobot project

DataSubset

Data subset for training predictions

DeleteComplianceDocTemplate

Deletes a compliance doc template.

DatetimeTrendPlotsResolutions

Datetime trend plots resolutions

CreateRandomPartition

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

DeletePredictJob

Function to delete one predict job from the DataRobot queue

CreatePrimeCode

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

CreateStratifiedPartition

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

DataPartition

Data Partition methods

DeletePredictionDataset

Delete a specified prediction dataset

DeleteTransferableModel

Delete this imported model.

DeleteProject

Delete a specified element from the DataRobot project list

DeploymentServiceHealthMetric

Deployment service health metrics

DeploymentAccuracyMetric

Deployment accuracy metrics

DatetimeTrendPlotsStatuses

Datetime trend plots statuses

DownloadTransferableModel

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

DownloadTrainingPredictions

Download training predictions on a specified data set.

DownloadComplianceDocTemplate

Download a compliance doc template (in JSON format).

DeleteModelingFeaturelist

Delete a modeling featurelist

DeleteModelJob

Delete a model job from the modeling queue

DeleteAnomalyAssessmentRecord

Delete anomaly assessment record.

DeleteModel

Delete a specified DataRobot model

DownloadComplianceDocumentation

Download compliance documentation (in DOCX format).

DeleteJob

Cancel a running job

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).

DataPathFromDataArg

Get the data path.

DeprecatedHeaderMessage

Handler for Deprecated header in API responses

DownloadTimeSeriesFeatureDerivationLog

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

DifferencingMethod

Differencing method

DownloadRatingTable

Download a rating table to a CSV.

DownloadSeriesAccuracy

Download the series accuracy for a model, computing it if not already computed.

GetBlenderModelFromJobId

Retrieve a new or updated blender model defined by modelJobId

GetBlenderModel

Retrieve the details of a specified blender model

GetBlueprint

Retrieve a blueprint

GetDataStoreTables

Get all tables associated with a data store.

GetConfusionChart

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

GetCrossValidationScores

Get cross validation scores

GetBlueprintChart

Retrieve a blueprint chart

DownloadScoringCode

Download scoring code JAR

GetDataStoreSchemas

Get the schemas associated with a data store.

GetBlueprintDocumentation

Get documentation for tasks used in the blueprint

GetAnomalyAssessmentExplanations

Retrieve anomaly assessment explanations.

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

DeleteDataStore

Delete a data store.

CreateGroupPartition

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

DeleteDataSource

Delete a data store.

DeletePredictionExplanations

Function to delete prediction explanations

GetDatetimePartition

Retrieve the DatetimePartitioning from a project

FeatureFromAsyncUrl

Retrieve a feature from the creation URL

GetDeploymentAccuracy

Retrieve accuracy statistics for a deployment.

GetCalendar

Retrieve a calendar

GetDatetimeModel

Retrieve the details of a specified datetime model.

DownloadPredictionExplanations

Function to download and save prediction explanations rows as csv file

DeletePredictionExplanationsInitialization

Delete the prediction explanations initialization for a model.

GetFrozenModelFromJobId

Retrieve a frozen model defined by modelJobId

GetDeployment

Get information on a particular deployment.

DownloadPrimeCode

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

GenerateDatetimePartition

Preview the full partitioning determined by a DatetimePartitioningSpecification

GetGeneralizedInsight

An internal function to help fetch insights.

GetFrozenModel

Retrieve the details of a specified frozen model

GetJob

Request information about a job

GetAccuracyOverTimePlot

Retrieve Accuracy over Time plot for a model.

GetAccuracyOverTimePlotsMetadata

Retrieve Accuracy over Time plots metadata for a model.

GetAccuracyOverTimePlotPreview

Retrieve Accuracy over Time preview plot for a model.

GetDataSource

Returns information about a particular data source.

GetModelBlueprintDocumentation

Get documentation for tasks used in the model blueprint

GetDeploymentAccuracyOverTime

Retrieves accuracy statistics over time on given metrics for a deployment.

GetModelCapabilities

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

GetDataStore

Returns information about a particular data store.

GetDeploymentServiceStats

Retrieve service health statistics for a deployment.

GetAnomalyAssessmentPredictionsPreview

Retrieve anomaly assessment predictions preview.

GetDeploymentAssociationId

Deployment Association ID

GetCalendarFromProject

Retrieve the calendar for a particular project.

GetModelJob

Request information about a single model job

GetFeatureAssociationMatrix

Get pairwise feature association statistics for a project's informative features

GetComplianceDocTemplate

Get a compliance doc template.

GetModelFromJobId

Retrieve a new or updated model defined by modelJobId

GetFeatureAssociationMatrixDetails

Get a sample of the actual values used to measure the association between a pair of features.

GetModelParameters

Retrieve model parameters

GetPredictJob

Request information about a predict job

GetPrimeModel

Retrieve information about specified DataRobot Prime model.

GetPrimeFileFromJobId

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

GetRatingTableFromJobId

Get a rating table from the rating table job metadata.

GetDeploymentServiceStatsOverTime

Retrieves service health statistics over time on given metrics for a deployment.

GetParetoFront

Pareto Front data for a Eureqa model

GetRatingTableModel

Retrieve information about specified model with a rating table.

GetPredictions

Retrieve model predictions

GetPredictionExplanationsRowsAsDataFrame

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

GetRocCurve

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

GetRulesets

List the rulesets approximating a model generated by DataRobot Prime

GetDatetimeModelFromJobId

Retrieve a new or updated datetime model defined by modelJobId

GetDeploymentDriftTrackingSettings

Get drift tracking settings for a deployment.

GetPrimeModelFromJobId

Retrieve information about specified DataRobot Prime model using corresponding jobId.

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)

GetFeatureHistogram

Retrieve histogram plot data for a specific feature

GetMissingValuesReport

Get a report on missing values for the model.

GetModelingFeaturelist

Retrieve a specific modeling featurelist from a DataRobot project

GetSeriesAccuracy

Get the computed series accuracy for a model, computing it if not already computed.

GetValidMetrics

Retrieve the valid fitting metrics for a specified project and target

GetProject

Retrieve details about a specified DataRobot modeling project

GetSeriesAccuracyForModel

Get the series accuracy associated with a particular model.

GetFeatureInfo

Details about a feature

GetModel

Retrieve the details of a specified model

GetFeaturelist

Retrieve a specific featurelist from a DataRobot project

GetPredictionExplanationsRows

Retrieve all prediction explanations rows

GetModelBlueprintChart

Retrieve a model blueprint chart

GetWordCloud

Retrieve word cloud data for a model.

GetPredictionExplanationsMetadataFromJobId

Retrieve the prediction explanations metadata for a model using jobId

GetPredictionExplanations

Get prediction explanations

GetPredictionExplanationsInitialization

Retrieve the prediction explanations initialization for a model.

GetDeploymentSettings

Retrieves all settings for a deployed model.

GetProjectStatus

Request Autopilot status for a specified DataRobot project

GetRatingTable

Retrieve a single rating table.

GetRatingTableModelFromJobId

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

GetRecommendedModel

Retrieve the model object that DataRobot recommends for your project.

GetMultiSeriesProperties

Retrieve time series properties for a potential multiseries datetime partition column

IsBlenderEligible

Check whether individual models can be blended together

ListDrivers

Returns a dataframe with information on available drivers.

ListFeatureInfo

Details about all features for this project

GetTimeSeriesFeatureDerivationLog

Retrieve the time series feature derivation log content

GetDriver

Returns information about a particular driver.

GetServerDataInRows

Handle server side pagination.

InitializeAnomalyAssessment

Request anomaly assessment insight computation on the specified subset.

PeriodicityMaxTimeStep

Periodicity max time step

ListModelJobs

Retrieve status of Autopilot modeling jobs that are not complete

ListModelRecommendations

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

GetTransferableModel

Retrieve imported model info using import id

GetTuningParameters

Retrieve data on tuning parameters for a particular model.

ListDeployments

List all current model deployments.

ListModelingFeaturelists

Retrieve all modeling featurelists associated with a project

ListDataStores

Returns a dataframe with information on available data stores.

GetTrainingPredictionDataFrame

Simplify the training prediction rows into a tidy format dataframe.

ListRocCurves

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

ListSharingAccess

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

RFC3339DateTimeFormat

RFC 3339 datetime format

RecommendedModelType

Recommended model type values

RequestApproximation

Request an approximation of a model using DataRobot Prime

RequestBlender

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

GetModelRecommendation

Retrieve a model recommendation from DataRobot for your project.

GetPrimeEligibility

Check if model can be approximated with DataRobot Prime

GetTrainingPredictions

Retrieve training predictions on a specified data set.

PeriodicityTimeUnits

Periodicity time units

RequestFrozenDatetimeModel

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

RequestFrozenModel

Train a new frozen model with parameters from specified model

GetFeatureImpactForModel

Retrieve completed Feature Impact results given a model

GetFeatureImpactForJobId

Retrieve completed Feature Impact results given a job ID

GetTrainingPredictionsForModel

Get training predictions for a particular model.

ListDataSources

Returns a dataframe with information on available data sources.

ListConfusionCharts

Returns all available confusion charts for the model.

GetTrainingPredictionsFromJobId

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

GetPrimeFile

Retrieve a specific Prime file from a DataRobot project

Share a shareable object with a particular user.

SetupProjectFromHDFS

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

SharingRole

Sharing role

GetPredictJobs

Function to list all prediction jobs in a project

SourceType

Source types

ListRatingTableModels

Retrieve information about all DataRobot models with a rating table.

ListModels

Retrieve all available model information for a DataRobot project

ListProjects

Retrieve a list of all DataRobot projects

MulticlassDeploymentAccuracyMetric

Accuracy metrics for multiclass deployments

PauseQueue

Pause the DataRobot modeling queue

ReformatMetrics

replace NULL in $metrics list elements with NA

UpdateAccess

Update access to a particular object.

RequestTransferableModel

Request creation of a transferable model

RequestTrainingPredictions

Request training predictions for a specific model.

GetPredictionDataset

Retrieve data on a prediction dataset

UpdateCalendar

Update a calendar

ListPrimeModels

Retrieve information about all DataRobot Prime models for a DataRobot project

ListPrimeFiles

List all downloadable code files from DataRobot Prime for the project

ListFeaturelists

Retrieve all featurelists associated with a project

ListJobs

Retrieve information about jobs

IsId

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

IsParameterIn

Check if a parameter is in a list of possibilities.

ValidateParameterIn

Ensure a parameter is valid

UpdateDataStore

Update a data store.

UpdateDeploymentDriftTrackingSettings

Update drift tracking settings for a deployment.

RegressionDeploymentAccuracyMetric

Accuracy metrics for regression deployments

RenameRatingTable

Renames a rating table to a different name.

ValidateReplaceDeployedModel

Validate a potential deployment model replacement.

ValidateProject

Get a projectId from a project object.

as.dataRobotProjectShort

Return value for SetupProject() and others

ValidatePartition

Checks if a partition is valid.

as.dataRobotMultiSeriesProperties

Return value for GetMultiSeriesProperties() and others

GetPredictionExplanationsMetadata

Retrieve metadata for specified prediction explanations

GetPredictionExplanationsInitializationFromJobId

Retrieve the prediction explanations initialization for a model using jobId

ReplaceDeployedModel

Replace a model in a deployment with another model.

RequestPredictionExplanations

Request prediction explanations computation for a specified model and dataset.

ListBlueprints

Retrieve the list of available blueprints for a project

ListAnomalyAssessmentRecords

Retrieve anomaly assessment records.

SegmentAnalysisAttribute

Segment analysis attributes

SeriesAggregationType

Series aggregation type

StarModel

Star a model.

StartProject

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

UnpauseQueue

Re-start the DataRobot modeling queue

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 - modeling jobs in queue would not be affected but new jobs would not be added to queue by halted autopilot.

RequestPredictionExplanationsInitialization

Request prediction explanations initialization for specified model

GetResidualsChart

Retrieve residuals chart data for a model for a data partition (see DataPartition).

ListComplianceDocTemplates

Retrieve information about all compliance doc templates.

ListCalendars

List all available calendars.

ListPredictionDatasets

Retrieve all prediction datasets associated with a project

GetRedirectFromResponse

Helper method to retrieve the redirect from the response headers to any request that puts or queries for a DR job. Use this in your job-related methods to simplify testing.

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.

transformRFC3339Period

The DataRobot Monitoring APIs return dates formatted as RFC 3339 strings. This is the same as ISO 8601. Specifically, 'T' is the date/time separator and 'Z' is used to denote UTC. Fractional seconds are returned. e.g. 2020-01-01T05:00:00.000000Z

UnstarModel

Unstar a model.

UpdateDeploymentSettings

Updates configuration settings for a deployed model.

UpdateComplianceDocTemplate

Update the name or sections of an existing doc template.

TestDataStore

Test the database connection to the data store.

TargetType

Target Type modes

ListModelFeatures

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

ListLiftCharts

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

ListPredictionServers

List all available prediction servers.

ListPredictions

Fetch all computed predictions for a project.

UpdateFeaturelist

Update a featurelist

ValidateMultiSeriesProperties

Validate that the multiseries properties indicate a successful multiseries setup.

ValidateModel

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

ListTransferableModels

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

MakeDataRobotRequest

Make a HTTP request

ProjectFromJobResponse

Retrieve a project from the job response, which has a project-creation URL

WaitForJobToComplete

Wait for specified job to complete

as.data.frame

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

plot.listOfModels

Plot method for DataRobot S3 objects of class listOfModels

Retrieve information about all rating tables.

ListPredictionExplanationsMetadata

Retrieve metadata for prediction explanations in specified project

validateReportingPeriodTime

Helper function for validating reporting period objects used by the deployment monitoring functions. See GetDeploymentServiceStats, GetDeploymentAccuracy, GetDeploymentServiceStatsOverTime, and GetDeploymentAccuracyOverTime.

as.dataRobotDeploymentAssociationIdSettings

Association ID settings for a deployment.

parseRFC3339Timestamp

as.dataRobotFeatureInfo

Information on a data feature.

formatRFC3339Timestamp

ListStarredModels

List all the starred models in a project.

ListTrainingPredictions

Retrieve information about all training prediction datasets in a project.

PredictionDatasetFromAsyncUrl

Retrieve prediction dataset info from the dataset creation URL

RequestCrossSeriesDetection

Format a cross series with group by columns.

PrimeLanguage

Prime Language

ListResidualsCharts

Retrieve residuals chart data for a model for all available data partitions (see DataPartition). This chart is only available for regression models that are not time-aware.

predict.dataRobotModel

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

ModelCapability

Model capabilities

ModelReplacementReason

Model replacement reason

PostgreSQLdrivers

PostgreSQL drivers

Predict

Retrieve model predictions

RequestMultiSeriesDetection

Format a multiseries.

RequestSeriesAccuracy

Compute the series accuracy for a model.

RequestNewDatetimeModel

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

RequestSampleSizeUpdate

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

SetupProject

Function to set up a new DataRobot project

RequestNewRatingTableModel

Create a new model from a rating table.

RequestFeatureImpact

Request Feature Impact to be computed.

RequestNewModel

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

StartTuningSession

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

SetupProjectFromDataSource

Create a project from a data source.

SetPredictionThreshold

Set a custom prediction threshold for binary classification models.

SetTarget

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

TreatAsExponential

Treat as exponential

Stringify

Convert a function into a single string for DataRobot

TryingToSubmitNull

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

UploadData

Upload a data source.

UploadPredictionDataset

Function to upload new data to a DataRobot project for predictions

UpdateTransferableModel

Update the display name or note for an imported model.

UploadComplianceDocTemplate

Upload a compliance doc template.

datarobot-package

datarobot: 'DataRobot' Predictive Modeling API

cvMethods

CV methods

RequestPredictions

Request predictions from a model against a previously uploaded dataset

TimeUnits

Time units

SubmitActuals

Submit actuals for processing.

TargetLeakageType

Target leakage report values

RequestPrimeModel

Request training for a DataRobot Prime model using a specified ruleset

ValidateCalendar

Get a calendar id from a calendar object.

RunInteractiveTuning

Run an interactive model tuning session.

WaitForAutopilot

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

reorderColumns

Reorder the columns in a data.frame

summary.dataRobotModel

DataRobot S3 object methods for R's generic summary function

ValidateActuals

Validate that the actuals are a dataframe and contain required columns.

ViewWebProject

Retrieve a DataRobot web page that displays detailed project information

ScoreBacktests

Compute the scores for all available backtests.

ToggleStarForModel

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

UpdateModelingFeaturelist

Update a modeling featurelist

summary.listOfDataRobotTuningParameters

Summarize the list of tuning parameters available for a model.

tidyServiceOverTimeObject

Tidies a ServiceOverTime response object for use in a DF

UploadPredictionDatasetFromDataSource

Upload a prediction dataset from a data source.

UpdateProject

Update parameters for an existing project

ViewWebModel

Retrieve a DataRobot web page that displays detailed model information

UploadTransferableModel

Import a previously exported model for predictions.

VariableTransformTypes

Types of variable transformations

ApplySchema

Apply a schema to DataRobot objects (lists, frames)

BlueprintChartToGraphviz

Convert a blueprint chart into graphviz DOT format

AddEureqaSolution

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

BlendMethods

Blend methods

CheckUrl

Make sure the path is a reasonable URL

CleanServerData

Reformat paginated data returned from the server.

BatchFeaturesTypeTransform

Create new features by transforming the type of an existing ones.

AutopilotMode

Autopilot modes

ClassificationDeploymentAccuracyMetric

Accuracy metrics for classification deployments