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

datarobot (version 2.18.5)

'DataRobot' Predictive Modeling API

Description

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

Copy Link

Version

Install

install.packages('datarobot')

Monthly Downloads

373

Version

2.18.5

License

MIT + file LICENSE

Maintainer

David Chudzicki

Last Published

November 2nd, 2023

Functions in datarobot (2.18.5)

CreateCalendar

Create a calendar from an uploaded CSV.

ConstructDurationString

Construct a valid string representing a duration in accordance with ISO8601

CreateComplianceDocumentation

Create compliance documentation from a model.

ComputeDatetimeTrendPlots

Compute datetime trend plots for datetime partitioned model.

CreateBacktestSpecification

Create a list describing backtest parameters

CreateDataSource

Create a data source.

CreateDeployment

Create a deployment.

CrossValidateModel

Run cross validation on a model.

CreateDataStore

Create a data store.

CreateDatetimePartitionSpecification

Create a list describing datetime partition parameters

CreateUserPartition

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

CreateRandomPartition

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

DeleteCalendar

Delete a calendar

CreateFeaturelist

Create a new featurelist in a DataRobot project

DeletePredictJob

Function to delete one predict job from the DataRobot queue

ConnectToDataRobot

Establish a connection to the DataRobot modeling engine

DeleteDataStore

Delete a data store.

DeleteComplianceDocTemplate

Deletes a compliance doc template.

CreatePrimeCode

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

CreateDerivedFeatures

Delete a specified DataRobot model

DataPartition

Data Partition methods

DeleteJob

Cancel a running job

DeletePredictionDataset

Delete a specified prediction dataset

CreateRatingTable

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

DownloadComplianceDocTemplate

Download a compliance doc template (in JSON format).

DifferencingMethod

Differencing method

DownloadSeriesAccuracy

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

DownloadComplianceDocumentation

Download compliance documentation (in DOCX format).

DeprecatedHeaderMessage

Handler for Deprecated header in API responses

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

DeleteFeaturelist

Delete a featurelist

CreateGroupPartition

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

DeleteAnomalyAssessmentRecord

Delete anomaly assessment record.

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

DeleteDeployment

Delete a deployment.

DatetimeTrendPlotsStatuses

Datetime trend plots statuses

DeleteProject

Delete a specified element from the DataRobot project list

DownloadRatingTable

Download a rating table to a CSV.

GetBlueprintDocumentation

Get documentation for tasks used in the blueprint

GetCalendar

Retrieve a calendar

DownloadScoringCode

Download scoring code JAR

DeleteTransferableModel

Delete this imported model.

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

DownloadTrainingPredictions

Download training predictions on a specified data set.

DeploymentServiceHealthMetric

Deployment service health metrics

DeploymentAccuracyMetric

Deployment accuracy metrics

DataSubset

Data subset for training predictions

GetDatetimePartition

Retrieve the DatetimePartitioning from a project

DatetimeTrendPlotsResolutions

Datetime trend plots resolutions

GetAnomalyAssessmentExplanations

Retrieve anomaly assessment explanations.

GetDeployment

Get information on a particular deployment.

GetBlueprint

Retrieve a blueprint

DownloadPredictionExplanations

Function to download and save prediction explanations rows as csv file

GetAccuracyOverTimePlot

Retrieve Accuracy over Time plot for a model.

DownloadPrimeCode

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

DeletePredictionExplanations

Function to delete prediction explanations

DeletePredictionExplanationsInitialization

Delete the prediction explanations initialization for a model.

GetBlueprintChart

Retrieve a blueprint chart

GenerateDatetimePartition

Preview the full partitioning determined by a DatetimePartitioningSpecification

GetFrozenModelFromJobId

Retrieve a frozen model defined by modelJobId

GetDatetimeModelFromJobId

Retrieve a new or updated datetime model defined by modelJobId

GetDriver

Returns information about a particular driver.

GetBlenderModel

Retrieve the details of a specified blender model

GetDatetimeModel

Retrieve the details of a specified datetime model.

GetCalendarFromProject

Retrieve the calendar for a particular project.

GetFrozenModel

Retrieve the details of a specified frozen model

GetDeploymentSettings

Retrieves all settings for a deployed model.

GetBlenderModelFromJobId

Retrieve a new or updated blender model defined by modelJobId

DownloadTimeSeriesFeatureDerivationLog

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

GetFeatureImpactForJobId

Retrieve completed Feature Impact results given a job ID

GetDataStoreSchemas

Get the schemas associated with a data store.

GetDataStoreTables

Get all tables associated with a data store.

GetComplianceDocTemplate

Get a compliance doc template.

DownloadTransferableModel

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

GetFeatureInfo

Details about a feature

GetModel

Retrieve the details of a specified model

GetDataStore

Returns information about a particular data store.

GetDataSource

Returns information about a particular data source.

GetAnomalyAssessmentPredictionsPreview

Retrieve anomaly assessment predictions preview.

GetDeploymentAccuracyOverTime

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

GetDeploymentAccuracy

Retrieve accuracy statistics for a deployment.

GetFeatureAssociationMatrix

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

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.

GetPredictJob

Request information about a predict job

GetModelBlueprintChart

Retrieve a model blueprint chart

GetParetoFront

Pareto Front data for a Eureqa model

GetModelJob

Request information about a single model job

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.

GetPredictionExplanationsInitializationFromJobId

Retrieve the prediction explanations initialization for a model using jobId

GetLiftChart

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

GetMissingValuesReport

Get a report on missing values for the model.

GetFeatureImpactForModel

Retrieve completed Feature Impact results given a model

GetMultiSeriesProperties

Retrieve time series properties for a potential multiseries datetime partition column

GetModelingFeaturelist

Retrieve a specific modeling featurelist from a DataRobot project

GetPrimeFileFromJobId

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

GetPrimeModel

Retrieve information about specified DataRobot Prime model.

GetPredictionExplanationsMetadata

Retrieve metadata for specified prediction explanations

GetTrainingPredictionsForModel

Get training predictions for a particular model.

IsId

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

IsParameterIn

Check if a parameter is in a list of possibilities.

GetTrainingPredictionsFromJobId

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

GetGeneralizedInsight

An internal function to help fetch insights.

GetModelRecommendation

Retrieve a model recommendation from DataRobot for your project.

GetModelCapabilities

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

GetModelParameters

Retrieve model parameters

GetFeaturelist

Retrieve a specific featurelist from a DataRobot project

GetModelBlueprintDocumentation

Get documentation for tasks used in the model blueprint

GetDeploymentServiceStats

Retrieve service health statistics for a deployment.

GetJob

Request information about a job

GetDeploymentServiceStatsOverTime

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

ListBlueprints

Retrieve the list of available blueprints for a project

ListAnomalyAssessmentRecords

Retrieve anomaly assessment records.

GetProjectStatus

Request Autopilot status for a specified DataRobot project

JobType

Job type

ListComplianceDocTemplates

Retrieve information about all compliance doc templates.

ListLiftCharts

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

ListCalendars

List all available calendars.

GetPredictionExplanations

Get prediction explanations

GetPredictionExplanationsRowsAsDataFrame

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

GetPrimeEligibility

Check if model can be approximated with DataRobot Prime

GetAccuracyOverTimePlotPreview

Retrieve Accuracy over Time preview plot for a model.

GetPredictions

Retrieve model predictions

GetResidualsChart

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

GetPredictionExplanationsInitialization

Retrieve the prediction explanations initialization for a model.

JobStatus

Job statuses

GetRulesets

List the rulesets approximating a model generated by DataRobot Prime

GetRocCurve

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

ModelCapability

Model capabilities

ListModelFeatures

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

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.

ModelReplacementReason

Model replacement reason

ListPrimeModels

Retrieve information about all DataRobot Prime models for a DataRobot project

ListModelRecommendations

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

ProjectFromJobResponse

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

ListPrimeFiles

List all downloadable code files from DataRobot Prime for the project

ListModelJobs

Retrieve status of Autopilot modeling jobs that are not complete

PeriodicityMaxTimeStep

Periodicity max time step

GetPrimeFile

Retrieve a specific Prime file from a DataRobot project

GetTimeSeriesFeatureDerivationLog

Retrieve the time series feature derivation log content

GetRatingTableFromJobId

Get a rating table from the rating table job metadata.

GetServerDataInRows

Handle server side pagination.

GetRatingTableModel

Retrieve information about specified model with a rating table.

ProjectStage

Project stage

GetWordCloud

Retrieve word cloud data for a model.

ListPredictionServers

List all available prediction servers.

GetValidMetrics

Retrieve the valid fitting metrics for a specified project and target

PeriodicityTimeUnits

Periodicity time units

PostgreSQLdrivers

PostgreSQL drivers

ListJobs

Retrieve information about jobs

ListDeployments

List all current model deployments.

ListFeaturelists

Retrieve all featurelists associated with a project

ListDataStores

Returns a dataframe with information on available data stores.

RequestCrossSeriesDetection

Format a cross series with group by columns.

ListPredictions

Fetch all computed predictions for a project.

MakeDataRobotRequest

Make a HTTP request

ListTransferableModels

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

GetRatingTable

Retrieve a single rating table.

GetAccuracyOverTimePlotsMetadata

Retrieve Accuracy over Time plots metadata for a model.

RequestMultiSeriesDetection

Format a multiseries.

RunInteractiveTuning

Run an interactive model tuning session.

RequestFeatureImpact

Request Feature Impact to be computed.

ScoreBacktests

Compute the scores for all available backtests.

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

RequestPredictions

Request predictions from a model against a previously uploaded dataset

ListRocCurves

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

PauseQueue

Pause the DataRobot modeling queue

RequestFrozenDatetimeModel

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

PrimeLanguage

Prime Language

PredictionDatasetFromAsyncUrl

Retrieve prediction dataset info from the dataset creation URL

ListSharingAccess

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

SetupProjectFromDataSource

Create a project from a data source.

SetupProject

Function to set up a new DataRobot project

MulticlassDeploymentAccuracyMetric

Accuracy metrics for multiclass deployments

GetCrossValidationScores

Get cross validation scores

GetFeatureHistogram

Retrieve histogram plot data for a specific feature

GetDeploymentDriftTrackingSettings

Get drift tracking settings for a deployment.

GetDeploymentAssociationId

Deployment Association ID

GetConfusionChart

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

RequestFrozenModel

Train a new frozen model with parameters from specified model

Predict

Retrieve model predictions

TargetType

Target Type modes

TestDataStore

Test the database connection to the data store.

UpdateFeaturelist

Update a featurelist

UpdateDeploymentSettings

Updates configuration settings for a deployed model.

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.

GetTuningParameters

Retrieve data on tuning parameters for a particular model.

ListModelingFeaturelists

Retrieve all modeling featurelists associated with a project

ListConfusionCharts

Returns all available confusion charts for the model.

ListModels

Retrieve all available model information for a DataRobot project

GetTransferableModel

Retrieve imported model info using import id

ListDataSources

Returns a dataframe with information on available data sources.

RequestTrainingPredictions

Request training predictions for a specific model.

RequestTransferableModel

Request creation of a transferable model

GetFeatureImpact

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

StarModel

Star a model.

UpdateAccess

Update access to a particular object.

SetPredictionThreshold

Set a custom prediction threshold for binary classification models.

SetTarget

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

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.

UpdateCalendar

Update a calendar

UploadTransferableModel

Import a previously exported model for predictions.

UploadPredictionDatasetFromDataSource

Upload a prediction dataset from a data source.

GetPredictJobs

Function to list all prediction jobs in a project

as.dataRobotDeploymentAssociationIdSettings

Association ID settings for a deployment.

UpdateComplianceDocTemplate

Update the name or sections of an existing doc template.

ToggleStarForModel

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

UpdateDataSource

Update a data store.

ListProjects

Retrieve a list of all DataRobot projects

plot.listOfModels

Plot method for DataRobot S3 objects of class listOfModels

SourceType

Source types

as.dataRobotFeatureInfo

Information on a data feature.

RenameRatingTable

Renames a rating table to a different name.

ReplaceDeployedModel

Replace a model in a deployment with another model.

validateReportingPeriodTime

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

ReformatMetrics

replace NULL in $metrics list elements with NA

ListRatingTableModels

Retrieve information about all DataRobot models with a rating table.

RequestApproximation

Request an approximation of a model using DataRobot Prime

RequestNewModel

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

GetPredictionDataset

Retrieve data on a prediction dataset

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

ValidateProject

Get a projectId from a project object.

ListTrainingPredictions

Retrieve information about all training prediction datasets in a project.

predict.dataRobotModel

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

RegressionDeploymentAccuracyMetric

Accuracy metrics for regression deployments

ListStarredModels

List all the starred models in a project.

GetProject

Retrieve details about a specified DataRobot modeling project

GetPredictionExplanationsRows

Retrieve all prediction explanations rows

GetPredictionExplanationsMetadataFromJobId

Retrieve the prediction explanations metadata for a model using jobId

GetPrimeModelFromJobId

Retrieve information about specified DataRobot Prime model using corresponding jobId.

GetTrainingPredictionDataFrame

Simplify the training prediction rows into a tidy format dataframe.

RequestNewRatingTableModel

Create a new model from 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.

RequestPredictionExplanations

Request prediction explanations computation for a specified model and dataset.

RequestPredictionExplanationsInitialization

Request prediction explanations initialization for specified model

ValidateReplaceDeployedModel

Validate a potential deployment model replacement.

cvMethods

CV methods

datarobot-package

datarobot: 'DataRobot' Predictive Modeling API

GetTrainingPredictions

Retrieve training predictions on a specified data set.

InitializeAnomalyAssessment

Request anomaly assessment insight computation on the specified subset.

StartTuningSession

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

Stringify

Convert a function into a single string for DataRobot

SetupProjectFromHDFS

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

ListDrivers

Returns a dataframe with information on available drivers.

IsBlenderEligible

Check whether individual models can be blended together

TreatAsExponential

Treat as exponential

TryingToSubmitNull

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

ValidatePartition

Checks if a partition is valid.

UpdateDeploymentDriftTrackingSettings

Update drift tracking settings for a deployment.

UpdateDataStore

Update a data store.

ValidateParameterIn

Ensure a parameter is valid

ListPredictionExplanationsMetadata

Retrieve metadata for prediction explanations in specified project

ListRatingTables

Retrieve information about all rating tables.

ListPredictionDatasets

Retrieve all prediction datasets associated with a project

ListFeatureInfo

Details about all features for this project

formatRFC3339Timestamp

ViewWebProject

Retrieve a DataRobot web page that displays detailed project information

WaitForAutopilot

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

ValidateMultiSeriesProperties

Validate that the multiseries properties indicate a successful multiseries setup.

VariableTransformTypes

Types of variable transformations

UpdateModelingFeaturelist

Update a modeling featurelist

ValidateModel

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

UpdateProject

Update parameters for an existing project

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.

RFC3339DateTimeFormat

RFC 3339 datetime format

RecommendedModelType

Recommended model type values

RequestSeriesAccuracy

Compute the series accuracy for a model.

RequestSampleSizeUpdate

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

SegmentAnalysisAttribute

Segment analysis attributes

ViewWebModel

Retrieve a DataRobot web page that displays detailed model information

StartProject

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

Share a shareable object with a particular user.

parseRFC3339Timestamp

ValidateCalendar

Get a calendar id from a calendar object.

SeriesAggregationType

Series aggregation type

SubmitActuals

Submit actuals for processing.

UnstarModel

Unstar a model.

UploadData

Upload a data source.

UnpauseQueue

Re-start the DataRobot modeling queue

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.

ValidateActuals

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

UpdateTransferableModel

Update the display name or note for an imported model.

as.data.frame

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

UploadComplianceDocTemplate

Upload a compliance doc template.

WaitForJobToComplete

Wait for specified job to complete

UploadPredictionDataset

Function to upload new data to a DataRobot project for predictions

as.dataRobotMultiSeriesProperties

Return value for GetMultiSeriesProperties() and others

as.dataRobotProjectShort

Return value for SetupProject() and others

TargetLeakageType

Target leakage report values

reorderColumns

Reorder the columns in a data.frame

summary.listOfDataRobotTuningParameters

Summarize the list of tuning parameters available for a model.

tidyServiceOverTimeObject

Tidies a ServiceOverTime response object for use in a DF

summary.dataRobotModel

DataRobot S3 object methods for R's generic summary function

ApplySchema

Apply a schema to DataRobot objects (lists, frames)

BlueprintChartToGraphviz

Convert a blueprint chart into graphviz DOT format

ClassificationDeploymentAccuracyMetric

Accuracy metrics for classification deployments

CheckUrl

Make sure the path is a reasonable URL

AddEureqaSolution

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

CleanServerData

Reformat paginated data returned from the server.

BatchFeaturesTypeTransform

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