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

datarobot (version 2.18.2)

'DataRobot' Predictive Modeling API

Description

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

Copy Link

Version

Install

install.packages('datarobot')

Monthly Downloads

413

Version

2.18.2

License

MIT + file LICENSE

Maintainer

David Chudzicki

Last Published

May 6th, 2022

Functions in datarobot (2.18.2)

ApplySchema

Apply a schema to DataRobot objects (lists, frames)

CheckUrl

Make sure the path is a reasonable URL

AutopilotMode

Autopilot modes

CleanServerData

Reformat paginated data returned from the server.

AddEureqaSolution

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

BatchFeaturesTypeTransform

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

BlendMethods

Blend methods

ClassificationDeploymentAccuracyMetric

Accuracy metrics for classification deployments

CloneProject

Clone a project

CreateDatetimePartitionSpecification

Create a list describing datetime partition parameters

ConnectToDataRobot

Establish a connection to the DataRobot modeling engine

ComputeDatetimeTrendPlots

Compute datetime trend plots for datetime partitioned model.

CreateComplianceDocumentation

Create compliance documentation from a model.

CreateCalendar

Create a calendar from an uploaded CSV.

CreateRatingTable

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

CreateDataSource

Create a data source.

CreateDataStore

Create a data store.

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

CreateGroupPartition

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

DeleteCalendar

Delete a calendar

DatetimeTrendPlotsStatuses

Datetime trend plots statuses

CreateStratifiedPartition

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

CreateDeployment

Create a deployment.

CreateDerivedFeatures

Derived Features

CreateFeaturelist

Create a new featurelist in a DataRobot project

DeleteComplianceDocTemplate

Deletes a compliance doc template.

DeleteAnomalyAssessmentRecord

Delete anomaly assessment record.

DeleteModelJob

Delete a model job from the modeling queue

DownloadComplianceDocTemplate

Download a compliance doc template (in JSON format).

DeleteModelingFeaturelist

Delete a modeling featurelist

DeletePredictionExplanations

Function to delete prediction explanations

DataSubset

Data subset for training predictions

DeletePredictionExplanationsInitialization

Delete the prediction explanations initialization for a model.

BlueprintChartToGraphviz

Convert a blueprint chart into graphviz DOT format

DeleteJob

Cancel a running job

DownloadComplianceDocumentation

Download compliance documentation (in DOCX format).

DeleteModel

Delete a specified DataRobot model

DownloadScoringCode

Download scoring code JAR

GetDatetimeModel

Retrieve the details of a specified datetime model.

DownloadSeriesAccuracy

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

GetDataStoreTables

Get all tables associated with a data store.

GetDeploymentServiceStatsOverTime

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

GetAccuracyOverTimePlotPreview

Retrieve Accuracy over Time preview plot for a model.

GetAccuracyOverTimePlot

Retrieve Accuracy over Time plot for a model.

DatetimeTrendPlotsResolutions

Datetime trend plots resolutions

CreatePrimeCode

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

GetDeploymentSettings

Retrieves all settings for a deployed model.

CreateRandomPartition

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

DownloadPredictionExplanations

Function to download and save prediction explanations rows as csv file

DataPathFromDataArg

Get the data path.

DeletePredictJob

Function to delete one predict job from the DataRobot queue

DataPartition

Data Partition methods

ConstructDurationString

Construct a valid string representing a duration in accordance with ISO8601

DownloadTransferableModel

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

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

GetFeatureImpact

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

CreateUserPartition

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

CreateBacktestSpecification

Create a list describing backtest parameters

GetBlueprintChart

Retrieve a blueprint chart

GetBlueprintDocumentation

Get documentation for tasks used in the blueprint

DeleteTransferableModel

Delete this imported model.

DeleteProject

Delete a specified element from the DataRobot project list

DeletePredictionDataset

Delete a specified prediction dataset

DownloadTrainingPredictions

Download training predictions on a specified data set.

DownloadTimeSeriesFeatureDerivationLog

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

GetAnomalyAssessmentPredictionsPreview

Retrieve anomaly assessment predictions preview.

GetFeatureImpactForJobId

Retrieve completed Feature Impact results given a job ID

DownloadRatingTable

Download a rating table to a CSV.

DownloadPrimeCode

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

GetCalendar

Retrieve a calendar

GetDatetimeModelFromJobId

Retrieve a new or updated datetime model defined by modelJobId

GetDatetimePartition

Retrieve the DatetimePartitioning from a project

GetCalendarFromProject

Retrieve the calendar for a particular project.

GetPredictionExplanationsInitialization

Retrieve the prediction explanations initialization for a model.

GetFeatureInfo

Details about a feature

GetFeatureImpactForModel

Retrieve completed Feature Impact results given a model

GetMissingValuesReport

Get a report on missing values for the model.

GetDeploymentServiceStats

Retrieve service health statistics for a deployment.

GetDeploymentDriftTrackingSettings

Get drift tracking settings for a deployment.

GetPredictionExplanations

Get prediction explanations

GetPredictionDataset

Retrieve data on a prediction dataset

GetPrimeModel

Retrieve information about specified DataRobot Prime model.

GetModel

Retrieve the details of a specified model

GetPredictionExplanationsInitializationFromJobId

Retrieve the prediction explanations initialization for a model using jobId

GetPredictionExplanationsMetadata

Retrieve metadata for specified prediction explanations

GetPredictionExplanationsMetadataFromJobId

Retrieve the prediction explanations metadata for a model using jobId

CrossValidateModel

Run cross validation on a model.

GetBlenderModelFromJobId

Retrieve a new or updated blender model defined by modelJobId

GetRatingTable

Retrieve a single rating table.

DeleteFeaturelist

Delete a featurelist

DeploymentServiceHealthMetric

Deployment service health metrics

DeleteDeployment

Delete a deployment.

GetJob

Request information about a job

GetModelRecommendation

Retrieve a model recommendation from DataRobot for your project.

GetLiftChart

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

GetModelingFeaturelist

Retrieve a specific modeling featurelist from a DataRobot project

GetBlueprint

Retrieve a blueprint

DeploymentAccuracyMetric

Deployment accuracy metrics

GetPrimeModelFromJobId

Retrieve information about specified DataRobot Prime model using corresponding jobId.

GetTrainingPredictions

Retrieve training predictions on a specified data set.

GetTuningParameters

Retrieve data on tuning parameters for a particular model.

GetTrainingPredictionsForModel

Get training predictions for a particular model.

GetBlenderModel

Retrieve the details of a specified blender model

GetDataStoreSchemas

Get the schemas associated with a data store.

GetDataStore

Returns information about a particular data store.

GetComplianceDocTemplate

Get a compliance doc template.

GetConfusionChart

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

GetDeploymentAccuracy

Retrieve accuracy statistics for a deployment.

GetDeployment

Get information on a particular deployment.

GetFrozenModelFromJobId

Retrieve a frozen model defined by modelJobId

GetRatingTableFromJobId

Get a rating table from the rating table job metadata.

GetValidMetrics

Retrieve the valid fitting metrics for a specified project and target

GetRatingTableModel

Retrieve information about specified model with a rating table.

GetPredictJob

Request information about a predict job

GetModelJob

Request information about a single model job

GetPrimeFile

Retrieve a specific Prime file from a DataRobot project

GetPrimeFileFromJobId

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

GetRatingTableModelFromJobId

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

GetModelParameters

Retrieve model parameters

GetGeneralizedInsight

An internal function to help fetch insights.

GetPredictJobs

Function to list all prediction jobs in a project

FeatureFromAsyncUrl

Retrieve a feature from the creation URL

IsBlenderEligible

Check whether individual models can be blended together

ListDataSources

Returns a dataframe with information on available data sources.

IsId

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

ListDataStores

Returns a dataframe with information on available data stores.

ListFeatureInfo

Details about all features for this project

GetAccuracyOverTimePlotsMetadata

Retrieve Accuracy over Time plots metadata for a model.

GetCrossValidationScores

Get cross validation scores

GetAnomalyAssessmentExplanations

Retrieve anomaly assessment explanations.

GenerateDatetimePartition

Preview the full partitioning determined by a DatetimePartitioningSpecification

GetDataSource

Returns information about a particular data source.

GetTrainingPredictionsFromJobId

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

GetDriver

Returns information about a particular driver.

GetTransferableModel

Retrieve imported model info using import id

IsParameterIn

Check if a parameter is in a list of possibilities.

GetProject

Retrieve details about a specified DataRobot modeling project

GetProjectStatus

Request Autopilot status for a specified DataRobot project

ListPredictionExplanationsMetadata

Retrieve metadata for prediction explanations in specified project

ListFeaturelists

Retrieve all featurelists associated with a project

GetDeploymentAccuracyOverTime

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

ListPredictionServers

List all available prediction servers.

ListRatingTables

Retrieve information about all rating tables.

ListPredictionDatasets

Retrieve all prediction datasets associated with a project

ListRatingTableModels

Retrieve information about all DataRobot models with a rating table.

ListModels

Retrieve all available model information for a DataRobot project

PeriodicityTimeUnits

Periodicity time units

GetFeatureAssociationMatrixDetails

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

GetDeploymentAssociationId

Deployment Association ID

PostgreSQLdrivers

PostgreSQL drivers

RFC3339DateTimeFormat

RFC 3339 datetime format

ProjectStage

Project stage

RenameRatingTable

Renames a rating table to a different name.

JobStatus

Job statuses

RegressionDeploymentAccuracyMetric

Accuracy metrics for regression deployments

GetFeatureHistogram

Retrieve histogram plot data for a specific feature

ListPredictions

Fetch all computed predictions for a project.

RequestFeatureImpact

Request Feature Impact to be computed.

GetModelFromJobId

Retrieve a new or updated model defined by modelJobId

GetPredictionExplanationsRows

Retrieve all prediction explanations rows

GetModelCapabilities

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

GetSeriesAccuracyForModel

Get the series accuracy associated with a particular model.

ListPrimeFiles

List all downloadable code files from DataRobot Prime for the project

ListComplianceDocTemplates

Retrieve information about all compliance doc templates.

GetServerDataInRows

Handle server side pagination.

GetPredictionExplanationsRowsAsDataFrame

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

GetFeatureAssociationMatrix

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

GetResidualsChart

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

GetRocCurve

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

RequestFrozenModel

Train a new frozen model with parameters from specified model

GetTimeSeriesFeatureDerivationLog

Retrieve the time series feature derivation log content

ListDeployments

List all current model deployments.

JobType

Job type

ListAnomalyAssessmentRecords

Retrieve anomaly assessment records.

GetTrainingPredictionDataFrame

Simplify the training prediction rows into a tidy format dataframe.

RequestFrozenDatetimeModel

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

RequestCrossSeriesDetection

Format a cross series with group by columns.

RequestSampleSizeUpdate

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

RequestPrimeModel

Request training for a DataRobot Prime model using a specified ruleset

RequestBlender

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

GetFeaturelist

Retrieve a specific featurelist from a DataRobot project

UnstarModel

Unstar a model.

GetModelBlueprintChart

Retrieve a model blueprint chart

GetFrozenModel

Retrieve the details of a specified frozen model

GetModelBlueprintDocumentation

Get documentation for tasks used in the model blueprint

GetMultiSeriesProperties

Retrieve time series properties for a potential multiseries datetime partition column

GetParetoFront

Pareto Front data for a Eureqa model

GetPrimeEligibility

Check if model can be approximated with DataRobot Prime

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.

GetRecommendedModel

Retrieve the model object that DataRobot recommends for your project.

GetPredictions

Retrieve model predictions

ScoreBacktests

Compute the scores for all available backtests.

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.

SegmentAnalysisAttribute

Segment analysis attributes

RequestMultiSeriesDetection

Format a multiseries.

RunInteractiveTuning

Run an interactive model tuning session.

RequestTransferableModel

Request creation of a transferable model

StartProject

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

ListConfusionCharts

Returns all available confusion charts for the model.

GetRulesets

List the rulesets approximating a model generated by DataRobot Prime

GetWordCloud

Retrieve word cloud data for a model.

GetSeriesAccuracy

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

InitializeAnomalyAssessment

Request anomaly assessment insight computation on the specified subset.

ListJobs

Retrieve information about jobs

ListDrivers

Returns a dataframe with information on available drivers.

TryingToSubmitNull

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

UnpauseQueue

Re-start the DataRobot modeling queue

SetupProjectFromDataSource

Create a project from a data source.

SetupProjectFromHDFS

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

ListBlueprints

Retrieve the list of available blueprints for a project

UpdateDeploymentDriftTrackingSettings

Update drift tracking settings for a deployment.

ListCalendars

List all available calendars.

StartTuningSession

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

TestDataStore

Test the database connection to the data store.

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.

TimeUnits

Time units

ListModelingFeaturelists

Retrieve all modeling featurelists associated with a project

ListModelRecommendations

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

ListLiftCharts

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

Update access to a particular object.

ListModelJobs

Retrieve status of Autopilot modeling jobs that are not complete

ListSharingAccess

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

ListModelFeatures

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

ListPrimeModels

Retrieve information about all DataRobot Prime models for a DataRobot project

PauseQueue

Pause the DataRobot modeling queue

ListStarredModels

List all the starred models in a project.

PeriodicityMaxTimeStep

Periodicity max time step

ListProjects

Retrieve a list of all DataRobot projects

ValidateCalendar

Get a calendar id from a calendar object.

ValidateModel

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

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.

ListTrainingPredictions

Retrieve information about all training prediction datasets in a project.

ListTransferableModels

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

ListRocCurves

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

ModelReplacementReason

Model replacement reason

UpdateFeaturelist

Update a featurelist

UpdateModelingFeaturelist

Update a modeling featurelist

UpdateDeploymentSettings

Updates configuration settings for a deployed model.

ValidateProject

Get a projectId from a project object.

ValidatePartition

Checks if a partition is valid.

ReplaceDeployedModel

Replace a model in a deployment with another model.

MulticlassDeploymentAccuracyMetric

Accuracy metrics for multiclass deployments

ValidateMultiSeriesProperties

Validate that the multiseries properties indicate a successful multiseries setup.

ReformatMetrics

replace NULL in $metrics list elements with NA

RequestApproximation

Request an approximation of a model using DataRobot Prime

ViewWebModel

Retrieve a DataRobot web page that displays detailed model information

Predict

Retrieve model predictions

RecommendedModelType

Recommended model type values

PredictionDatasetFromAsyncUrl

Retrieve prediction dataset info from the dataset creation URL

WaitForAutopilot

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

RequestPredictionExplanations

Request prediction explanations computation for a specified model and dataset.

SetPredictionThreshold

Set a custom prediction threshold for binary classification models.

Stringify

Convert a function into a single string for DataRobot

SubmitActuals

Submit actuals for processing.

UploadComplianceDocTemplate

Upload a compliance doc template.

RequestNewRatingTableModel

Create a new model from a rating table.

SeriesAggregationType

Series aggregation type

ValidateParameterIn

Ensure a parameter is valid

ViewWebProject

Retrieve a DataRobot web page that displays detailed project information

RequestNewDatetimeModel

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

UploadTransferableModel

Import a previously exported model for predictions.

parseRFC3339Timestamp

ValidateActuals

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

UploadData

Upload a data source.

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

as.dataRobotDeploymentAssociationIdSettings

Association ID settings for a deployment.

ProjectFromJobResponse

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

ValidateReplaceDeployedModel

Validate a potential deployment model replacement.

PrimeLanguage

Prime Language

RequestPredictionExplanationsInitialization

Request prediction explanations initialization for specified model

RequestNewModel

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

RequestPredictions

Request predictions from a model against a previously uploaded dataset

Share a shareable object with a particular user.

summary.dataRobotModel

DataRobot S3 object methods for R's generic summary function

summary.listOfDataRobotTuningParameters

Summarize the list of tuning parameters available for a model.

VariableTransformTypes

Types of variable transformations

WaitForJobToComplete

Wait for specified job to complete

validateReportingPeriodTime

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

SetupProject

Function to set up a new DataRobot project

RequestTrainingPredictions

Request training predictions for a specific model.

SetTarget

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

RequestSeriesAccuracy

Compute the series accuracy for a model.

UpdateComplianceDocTemplate

Update the name or sections of an existing doc template.

SharingRole

Sharing role

TargetLeakageType

Target leakage report values

UpdateProject

Update parameters for an existing project

UpdateTransferableModel

Update the display name or note for an imported model.

UploadPredictionDatasetFromDataSource

Upload a prediction dataset from a data source.

UploadPredictionDataset

Function to upload new data to a DataRobot project for predictions

as.dataRobotFeatureInfo

Information on a data feature.

as.dataRobotMultiSeriesProperties

Return value for GetMultiSeriesProperties() and others

datarobot-package

datarobot: 'DataRobot' Predictive Modeling API

ToggleStarForModel

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

predict.dataRobotModel

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

tidyServiceOverTimeObject

Tidies a ServiceOverTime response object for use in a DF

reorderColumns

Reorder the columns in a data.frame

as.dataRobotProjectShort

Return value for SetupProject() and others

cvMethods

CV methods

formatRFC3339Timestamp

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