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

datarobot (version 2.18.4)

'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.18.4

License

MIT + file LICENSE

Maintainer

David Chudzicki

Last Published

August 7th, 2023

Functions in datarobot (2.18.4)

AddEureqaSolution

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

CreateDatetimePartitionSpecification

Create a list describing datetime partition parameters

CreateCalendar

Create a calendar from an uploaded CSV.

CreateDataSource

Create a data source.

ConstructDurationString

Construct a valid string representing a duration in accordance with ISO8601

CreateBacktestSpecification

Create a list describing backtest parameters

CreateDataStore

Create a data store.

ComputeDatetimeTrendPlots

Compute datetime trend plots for datetime partitioned model.

CreateComplianceDocumentation

Create compliance documentation from a model.

CreateDeployment

Create a deployment.

ConnectToDataRobot

Establish a connection to the DataRobot modeling engine

CreatePrimeCode

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

CreateDerivedFeatures

Derived Features

CreateRandomPartition

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

CreateGroupPartition

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

CreateRatingTable

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

DataSubset

Data subset for training predictions

DatetimeTrendPlotsResolutions

Datetime trend plots resolutions

DeletePredictionExplanations

Function to delete prediction explanations

DeletePredictionExplanationsInitialization

Delete the prediction explanations initialization for a model.

CreateUserPartition

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

Run cross validation on a model.

DeleteModel

Delete a specified DataRobot model

DeleteDataSource

Delete a data store.

DatetimeTrendPlotsStatuses

Datetime trend plots statuses

DeleteModelJob

Delete a model job from the modeling queue

CreateStratifiedPartition

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

DeleteModelingFeaturelist

Delete a modeling featurelist

DeleteAnomalyAssessmentRecord

Delete anomaly assessment record.

DeploymentAccuracyMetric

Deployment accuracy metrics

DifferencingMethod

Differencing method

DeleteTransferableModel

Delete this imported model.

DeploymentServiceHealthMetric

Deployment service health metrics

DeprecatedHeaderMessage

Handler for Deprecated header in API responses

DataPartition

Data Partition methods

CreateFeaturelist

Create a new featurelist in a DataRobot project

DeleteComplianceDocTemplate

Deletes a compliance doc template.

DeleteCalendar

Delete a calendar

DownloadPredictionExplanations

Function to download and save prediction explanations rows as csv file

DataPathFromDataArg

Get the data path.

DownloadScoringCode

Download scoring code JAR

DownloadRatingTable

Download a rating table to a CSV.

DownloadPrimeCode

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

DownloadSeriesAccuracy

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

DownloadTimeSeriesFeatureDerivationLog

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

DeletePredictJob

Function to delete one predict job from the DataRobot queue

DeletePredictionDataset

Delete a specified prediction dataset

GetBlueprint

Retrieve a blueprint

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

DownloadComplianceDocTemplate

Download a compliance doc template (in JSON format).

DownloadComplianceDocumentation

Download compliance documentation (in DOCX format).

GetAnomalyAssessmentExplanations

Retrieve anomaly assessment explanations.

GetAnomalyAssessmentPredictionsPreview

Retrieve anomaly assessment predictions preview.

GetBlueprintChart

Retrieve a blueprint chart

GetCalendarFromProject

Retrieve the calendar for a particular project.

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

GetCrossValidationScores

Get cross validation scores

GetBlueprintDocumentation

Get documentation for tasks used in the blueprint

FeatureFromAsyncUrl

Retrieve a feature from the creation URL

GetConfusionChart

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

GetCalendar

Retrieve a calendar

DownloadTrainingPredictions

Download training predictions on a specified data set.

DeleteProject

Delete a specified element from the DataRobot project list

DeleteDeployment

Delete a deployment.

GetComplianceDocTemplate

Get a compliance doc template.

GetBlenderModel

Retrieve the details of a specified blender model

GetDataStoreSchemas

Get the schemas associated with a data store.

GetBlenderModelFromJobId

Retrieve a new or updated blender model defined by modelJobId

DownloadTransferableModel

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

GetDeploymentDriftTrackingSettings

Get drift tracking settings for a deployment.

GetDeploymentAssociationId

Deployment Association ID

GetDeploymentServiceStatsOverTime

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

GetDeploymentServiceStats

Retrieve service health statistics for a deployment.

GetAccuracyOverTimePlot

Retrieve Accuracy over Time plot for a model.

GetDatetimeModel

Retrieve the details of a specified datetime model.

GetAccuracyOverTimePlotPreview

Retrieve Accuracy over Time preview plot for a model.

GetDatetimeModelFromJobId

Retrieve a new or updated datetime model defined by modelJobId

GenerateDatetimePartition

Preview the full partitioning determined by a DatetimePartitioningSpecification

GetAccuracyOverTimePlotsMetadata

Retrieve Accuracy over Time plots metadata for a model.

DeleteFeaturelist

Delete a featurelist

GetFeatureImpactForJobId

Retrieve completed Feature Impact results given a job ID

GetDeployment

Get information on a particular deployment.

GetFeaturelist

Retrieve a specific featurelist from a DataRobot project

GetFeatureInfo

Details about a feature

GetDatetimePartition

Retrieve the DatetimePartitioning from a project

GetFeatureImpactForModel

Retrieve completed Feature Impact results given a model

GetDataStoreTables

Get all tables associated with a data store.

GetFeatureHistogram

Retrieve histogram plot data for a specific feature

GetGeneralizedInsight

An internal function to help fetch insights.

GetDriver

Returns information about a particular driver.

GetDeploymentSettings

Retrieves all settings for a deployed model.

GetFrozenModelFromJobId

Retrieve a frozen model defined by modelJobId

GetFrozenModel

Retrieve the details of a specified frozen model

GetModelFromJobId

Retrieve a new or updated model defined by modelJobId

GetDataSource

Returns information about a particular data source.

GetFeatureAssociationMatrix

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

GetDeploymentAccuracyOverTime

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

GetDataStore

Returns information about a particular data store.

GetDeploymentAccuracy

Retrieve accuracy statistics for a deployment.

GetFeatureAssociationMatrixDetails

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

GetModelJob

Request information about a single model job

GetJob

Request information about a job

GetLiftChart

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

GetMissingValuesReport

Get a report on missing values for the model.

GetModelRecommendation

Retrieve a model recommendation from DataRobot for your project.

GetModelParameters

Retrieve model parameters

GetFeatureImpact

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

GetPredictionExplanations

Get prediction explanations

GetPredictionExplanationsMetadata

Retrieve metadata for specified prediction explanations

GetPredictionExplanationsInitializationFromJobId

Retrieve the prediction explanations initialization for a model using jobId

GetModelingFeaturelist

Retrieve a specific modeling featurelist from a DataRobot project

GetMultiSeriesProperties

Retrieve time series properties for a potential multiseries datetime partition column

GetPrimeModel

Retrieve information about specified DataRobot Prime model.

GetModelCapabilities

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

GetParetoFront

Pareto Front data for a Eureqa model

GetPrimeFileFromJobId

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

GetModelBlueprintDocumentation

Get documentation for tasks used in the model blueprint

GetModelBlueprintChart

Retrieve a model blueprint chart

GetPredictJob

Request information about a predict job

GetModel

Retrieve the details of a specified model

GetPredictionExplanationsMetadataFromJobId

Retrieve the prediction explanations metadata for a model using jobId

GetPrimeEligibility

Check if model can be approximated with DataRobot Prime

GetPredictionExplanationsInitialization

Retrieve the prediction explanations initialization for a model.

GetPredictionExplanationsRows

Retrieve all prediction explanations rows

GetProjectStatus

Request Autopilot status for a specified DataRobot project

GetRatingTableFromJobId

Get a rating table from the rating table job metadata.

GetPrimeFile

Retrieve a specific Prime file from a DataRobot project

GetTrainingPredictionDataFrame

Simplify the training prediction rows into a tidy format dataframe.

GetRatingTable

Retrieve a single rating table.

GetSeriesAccuracyForModel

Get the series accuracy associated with a particular model.

GetSeriesAccuracy

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

GetTrainingPredictionsForModel

Get training predictions for a particular model.

GetPredictionExplanationsRowsAsDataFrame

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

GetPrimeModelFromJobId

Retrieve information about specified DataRobot Prime model using corresponding jobId.

GetPredictions

Retrieve model predictions

GetProject

Retrieve details about a specified DataRobot modeling project

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.

GetServerDataInRows

Handle server side pagination.

GetPredictionDataset

Retrieve data on a prediction dataset

GetTimeSeriesFeatureDerivationLog

Retrieve the time series feature derivation log content

GetPredictJobs

Function to list all prediction jobs in a project

GetRatingTableModel

Retrieve information about specified model with a rating table.

GetTrainingPredictions

Retrieve training predictions on a specified data set.

JobStatus

Job statuses

GetTrainingPredictionsFromJobId

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

IsId

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

ListDataStores

Returns a dataframe with information on available data stores.

JobType

Job type

ListCalendars

List all available calendars.

ListComplianceDocTemplates

Retrieve information about all compliance doc templates.

GetTransferableModel

Retrieve imported model info using import id

ListModelRecommendations

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

ListModelJobs

Retrieve status of Autopilot modeling jobs that are not complete

ListDeployments

List all current model deployments.

ListPredictionServers

List all available prediction servers.

ListFeaturelists

Retrieve all featurelists associated with a project

ListJobs

Retrieve information about jobs

IsParameterIn

Check if a parameter is in a list of possibilities.

ListModels

Retrieve all available model information for a DataRobot project

ListPrimeFiles

List all downloadable code files from DataRobot Prime for the project

ListPrimeModels

Retrieve information about all DataRobot Prime models for a DataRobot project

ListModelingFeaturelists

Retrieve all modeling featurelists associated with a project

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.

MulticlassDeploymentAccuracyMetric

Accuracy metrics for multiclass deployments

PauseQueue

Pause the DataRobot modeling queue

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.

GetRocCurve

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

InitializeAnomalyAssessment

Request anomaly assessment insight computation on the specified subset.

GetResidualsChart

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

ListConfusionCharts

Returns all available confusion charts for the model.

GetTuningParameters

Retrieve data on tuning parameters for a particular model.

ListPredictionExplanationsMetadata

Retrieve metadata for prediction explanations in specified project

ProjectStage

Project stage

ProjectFromJobResponse

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

ListDataSources

Returns a dataframe with information on available data sources.

ListBlueprints

Retrieve the list of available blueprints for a project

IsBlenderEligible

Check whether individual models can be blended together

ListLiftCharts

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

ListAnomalyAssessmentRecords

Retrieve anomaly assessment records.

ListProjects

Retrieve a list of all DataRobot projects

GetRulesets

List the rulesets approximating a model generated by DataRobot Prime

PeriodicityMaxTimeStep

Periodicity max time step

ReformatMetrics

replace NULL in $metrics list elements with NA

ListPredictions

Fetch all computed predictions for a project.

RegressionDeploymentAccuracyMetric

Accuracy metrics for regression deployments

ListModelFeatures

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

ListRatingTableModels

Retrieve information about all DataRobot models with a rating table.

RequestBlender

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

ModelReplacementReason

Model replacement reason

RequestApproximation

Request an approximation of a model using DataRobot Prime

ModelCapability

Model capabilities

PredictionDatasetFromAsyncUrl

Retrieve prediction dataset info from the dataset creation URL

PrimeLanguage

Prime Language

RequestMultiSeriesDetection

Format a multiseries.

PeriodicityTimeUnits

Periodicity time units

SetupProject

Function to set up a new DataRobot project

RequestPredictionExplanations

Request prediction explanations computation for a specified model and dataset.

RequestPredictionExplanationsInitialization

Request prediction explanations initialization for specified model

SetupProjectFromDataSource

Create a project from a data source.

GetValidMetrics

Retrieve the valid fitting metrics for a specified project and target

GetWordCloud

Retrieve word cloud data for a model.

ListRatingTables

Retrieve information about all rating tables.

SetupProjectFromHDFS

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

Share a shareable object with a particular user.

RunInteractiveTuning

Run an interactive model tuning session.

SharingRole

Sharing role

ScoreBacktests

Compute the scores for all available backtests.

RequestPredictions

Request predictions from a model against a previously uploaded dataset

SubmitActuals

Submit actuals for processing.

RequestNewDatetimeModel

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

RequestPrimeModel

Request training for a DataRobot Prime model using a specified ruleset

MakeDataRobotRequest

Make a HTTP request

ListTransferableModels

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

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.

ListFeatureInfo

Details about all features for this project

ListDrivers

Returns a dataframe with information on available drivers.

RFC3339DateTimeFormat

RFC 3339 datetime format

SourceType

Source types

SegmentAnalysisAttribute

Segment analysis attributes

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.

Predict

Retrieve model predictions

StartProject

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

RenameRatingTable

Renames a rating table to a different name.

RequestSampleSizeUpdate

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

TreatAsExponential

Treat as exponential

ReplaceDeployedModel

Replace a model in a deployment with another model.

RequestSeriesAccuracy

Compute the series accuracy for a model.

TimeUnits

Time units

UpdateTransferableModel

Update the display name or note for an imported model.

UpdateFeaturelist

Update a featurelist

UnpauseQueue

Re-start the DataRobot modeling queue

TryingToSubmitNull

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

UnstarModel

Unstar a model.

TargetLeakageType

Target leakage report values

UpdateDeploymentSettings

Updates configuration settings for a deployed model.

UploadComplianceDocTemplate

Upload a compliance doc template.

UploadData

Upload a data source.

UploadPredictionDataset

Function to upload new data to a DataRobot project for predictions

ValidatePartition

Checks if a partition is valid.

ValidateParameterIn

Ensure a parameter is valid

UpdateDeploymentDriftTrackingSettings

Update drift tracking settings for a deployment.

VariableTransformTypes

Types of variable transformations

UpdateDataStore

Update a data store.

ValidateModel

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

ToggleStarForModel

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

RecommendedModelType

Recommended model type values

SeriesAggregationType

Series aggregation type

RequestFrozenDatetimeModel

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

RequestNewRatingTableModel

Create a new model from a rating table.

as.dataRobotMultiSeriesProperties

Return value for GetMultiSeriesProperties() and others

ViewWebModel

Retrieve a DataRobot web page that displays detailed model information

as.dataRobotProjectShort

Return value for SetupProject() and others

ValidateMultiSeriesProperties

Validate that the multiseries properties indicate a successful multiseries setup.

as.data.frame

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

WaitForJobToComplete

Wait for specified job to complete

ViewWebProject

Retrieve a DataRobot web page that displays detailed project information

RequestFrozenModel

Train a new frozen model with parameters from specified model

reorderColumns

Reorder the columns in a data.frame

datarobot-package

datarobot: 'DataRobot' Predictive Modeling API

summary.dataRobotModel

DataRobot S3 object methods for R's generic summary function

cvMethods

CV methods

ValidateProject

Get a projectId from a project object.

RequestNewModel

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

ValidateReplaceDeployedModel

Validate a potential deployment model replacement.

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

validateReportingPeriodTime

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

StartTuningSession

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

TestDataStore

Test the database connection to the data store.

Stringify

Convert a function into a single string for DataRobot

TargetType

Target Type modes

ListPredictionDatasets

Retrieve all prediction datasets associated with a project

StarModel

Star a model.

ListTrainingPredictions

Retrieve information about all training prediction datasets in a project.

ListStarredModels

List all the starred models in a project.

predict.dataRobotModel

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

plot.listOfModels

Plot method for DataRobot S3 objects of class listOfModels

RequestTransferableModel

Request creation of a transferable model

RequestTrainingPredictions

Request training predictions for a specific model.

RequestFeatureImpact

Request Feature Impact to be computed.

RequestCrossSeriesDetection

Format a cross series with group by columns.

UpdateModelingFeaturelist

Update a modeling featurelist

UploadTransferableModel

Import a previously exported model for predictions.

ValidateActuals

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

SetTarget

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

SetPredictionThreshold

Set a custom prediction threshold for binary classification models.

as.dataRobotDeploymentAssociationIdSettings

Association ID settings for a deployment.

summary.listOfDataRobotTuningParameters

Summarize the list of tuning parameters available for a model.

UploadPredictionDatasetFromDataSource

Upload a prediction dataset from a data source.

WaitForAutopilot

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

UpdateProject

Update parameters for an existing project

parseRFC3339Timestamp

UpdateAccess

Update access to a particular object.

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.

tidyServiceOverTimeObject

Tidies a ServiceOverTime response object for use in a DF

formatRFC3339Timestamp

UpdateComplianceDocTemplate

Update the name or sections of an existing doc template.

ValidateCalendar

Get a calendar id from a calendar object.

UpdateDataSource

Update a data store.

as.dataRobotFeatureInfo

Information on a data feature.

ApplySchema

Apply a schema to DataRobot objects (lists, frames)

ClassificationDeploymentAccuracyMetric

Accuracy metrics for classification deployments

BlueprintChartToGraphviz

Convert a blueprint chart into graphviz DOT format

CheckUrl

Make sure the path is a reasonable URL

CloneProject

Clone a project

BatchFeaturesTypeTransform

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

CleanServerData

Reformat paginated data returned from the server.