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

datarobot (version 2.18.0)

'DataRobot' Predictive Modeling API

Description

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

Copy Link

Version

Install

install.packages('datarobot')

Monthly Downloads

390

Version

2.18.0

License

MIT + file LICENSE

Maintainer

David Chudzicki

Last Published

June 2nd, 2021

Functions in datarobot (2.18.0)

ClassificationDeploymentAccuracyMetric

Accuracy metrics for classification deployments

BatchFeaturesTypeTransform

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

CloneProject

Clone a project

CleanServerData

Reformat paginated data returned from the server.

BlueprintChartToGraphviz

Convert a blueprint chart into graphviz DOT format

CheckUrl

Make sure the path is a reasonable URL

AddEureqaSolution

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

Create a calendar from an uploaded CSV.

CreateDatetimePartitionSpecification

Create a list describing datetime partition parameters

CreateDataSource

Create a data source.

CreateGroupPartition

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

DeletePredictionExplanations

Function to delete prediction 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

CreateDataStore

Create a data store.

ConstructDurationString

Construct a valid string representing a duration in accordance with ISO8601

CreateBacktestSpecification

Create a list describing backtest parameters

CreateUserPartition

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

ApplySchema

Apply a schema to DataRobot objects (lists, frames)

CrossValidateModel

Run cross validation on a model.

DeletePredictionExplanationsInitialization

Delete the prediction explanations initialization for a model.

CreateDeployment

Create a deployment.

CreatePrimeCode

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

CreateDerivedFeatures

Derived Features

CreateComplianceDocumentation

Create compliance documentation from a model.

ComputeDatetimeTrendPlots

Compute datetime trend plots for datetime partitioned model.

DeleteModelJob

Delete a model job from the modeling queue

DeleteDataSource

Delete a data store.

CreateFeaturelist

Create a new featurelist in a DataRobot project

DeleteDataStore

Delete a data store.

DeleteAnomalyAssessmentRecord

Delete anomaly assessment record.

DatetimeTrendPlotsStatuses

Datetime trend plots statuses

DeletePredictJob

Function to delete one predict job from the DataRobot queue

DeleteModelingFeaturelist

Delete a modeling featurelist

DataSubset

Data subset for training predictions

ConnectToDataRobot

Establish a connection to the DataRobot modeling engine

DeleteProject

Delete a specified element from the DataRobot project list

DownloadComplianceDocumentation

Download compliance documentation (in DOCX format).

DeletePredictionDataset

Delete a specified prediction dataset

FeatureFromAsyncUrl

Retrieve a feature from the creation URL

DownloadScoringCode

Download scoring code JAR

DownloadPrimeCode

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

DownloadRatingTable

Download a rating table to a CSV.

DatetimeTrendPlotsResolutions

Datetime trend plots resolutions

DownloadPredictionExplanations

Function to download and save prediction explanations rows as csv file

DownloadTimeSeriesFeatureDerivationLog

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

CreateStratifiedPartition

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

CreateRatingTable

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

GetAnomalyAssessmentPredictionsPreview

Retrieve anomaly assessment predictions preview.

GenerateDatetimePartition

Preview the full partitioning determined by a DatetimePartitioningSpecification

GetAccuracyOverTimePlotsMetadata

Retrieve Accuracy over Time plots metadata for a model.

DeleteTransferableModel

Delete this imported model.

GetBlenderModel

Retrieve the details of a specified blender model

GetDeployment

Get information on a particular deployment.

GetFeatureAssociationMatrixDetails

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

GetDeploymentAccuracy

Retrieve accuracy statistics for a deployment.

CreateRandomPartition

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

GetFeatureHistogram

Retrieve histogram plot data for a specific feature

DataPathFromDataArg

Get the data path.

DataPartition

Data Partition methods

GetAnomalyAssessmentExplanations

Retrieve anomaly assessment explanations.

GetFeatureInfo

Details about a feature

GetModelFromJobId

Retrieve a new or updated model defined by modelJobId

GetDeploymentSettings

Retrieves all settings for a deployed model.

GetDeploymentServiceStatsOverTime

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

GetFeatureImpactForModel

Retrieve completed Feature Impact results given a model

GetModelCapabilities

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

DeleteJob

Cancel a running job

GetPredictJob

Request information about a predict job

DeleteModel

Delete a specified DataRobot model

GetBlueprintDocumentation

Get documentation for tasks used in the blueprint

DownloadTransferableModel

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

DeleteComplianceDocTemplate

Deletes a compliance doc template.

DeleteCalendar

Delete a calendar

DeploymentAccuracyMetric

Deployment accuracy metrics

GetBlueprintChart

Retrieve a blueprint chart

DeleteDeployment

Delete a deployment.

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

DeploymentServiceHealthMetric

Deployment service health metrics

GetJob

Request information about a job

DeleteFeaturelist

Delete a featurelist

DownloadComplianceDocTemplate

Download a compliance doc template (in JSON format).

GetBlueprint

Retrieve a blueprint

GetDataSource

Returns information about a particular data source.

DifferencingMethod

Differencing method

GetBlenderModelFromJobId

Retrieve a new or updated blender model defined by modelJobId

GetCrossValidationScores

Get cross validation scores

DownloadSeriesAccuracy

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

GetCalendar

Retrieve a calendar

GetCalendarFromProject

Retrieve the calendar for a particular project.

GetDataStoreTables

Get all tables associated with a data store.

GetPredictJobs

Function to list all prediction jobs in a project

GetModelJob

Request information about a single model job

GetLiftChart

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

GetPredictionExplanationsRows

Retrieve all prediction explanations rows

GetComplianceDocTemplate

Get a compliance doc template.

GetDataStore

Returns information about a particular data store.

DownloadTrainingPredictions

Download training predictions on a specified data set.

GetConfusionChart

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

GetDatetimeModelFromJobId

Retrieve a new or updated datetime model defined by modelJobId

GetDatetimePartition

Retrieve the DatetimePartitioning from a project

GetModelParameters

Retrieve model parameters

GetPredictionExplanationsRowsAsDataFrame

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

GetRatingTableModel

Retrieve information about specified model with a rating table.

GetRatingTableModelFromJobId

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

GetDeploymentAccuracyOverTime

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

GetDeploymentDriftTrackingSettings

Get drift tracking settings for a deployment.

GetDatetimeModel

Retrieve the details of a specified datetime model.

GetDeploymentServiceStats

Retrieve service health statistics for a deployment.

JobStatus

Job statuses

IsParameterIn

Check if a parameter is in a list of possibilities.

GetDataStoreSchemas

Get the schemas associated with a data store.

GetFeatureAssociationMatrix

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

GetModelBlueprintDocumentation

Get documentation for tasks used in the model blueprint

GetFrozenModel

Retrieve the details of a specified frozen model

GetFeaturelist

Retrieve a specific featurelist from a DataRobot project

GetModelBlueprintChart

Retrieve a model blueprint chart

GetDriver

Returns information about a particular driver.

GetMultiSeriesProperties

Retrieve time series properties for a potential multiseries datetime partition column

GetFrozenModelFromJobId

Retrieve a frozen model defined by modelJobId

GetRatingTable

Retrieve a single rating table.

GetRatingTableFromJobId

Get a rating table from the rating table job metadata.

GetPredictionExplanationsInitializationFromJobId

Retrieve the prediction explanations initialization for a model using jobId

GetPrimeFileFromJobId

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

GetPredictionExplanationsInitialization

Retrieve the prediction explanations initialization for a model.

GetPrimeFile

Retrieve a specific Prime file from a DataRobot project

GetTrainingPredictions

Retrieve training predictions on a specified data set.

ListCalendars

List all available calendars.

GetTrainingPredictionsForModel

Get training predictions for a particular model.

ListBlueprints

Retrieve the list of available blueprints for a project

GetDeploymentAssociationId

Deployment Association ID

GetFeatureImpact

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

GetMissingValuesReport

Get a report on missing values for the model.

GetGeneralizedInsight

An internal function to help fetch insights.

GetModel

Retrieve the details of a specified model

GetSeriesAccuracyForModel

Get the series accuracy associated with a particular model.

GetPredictions

Retrieve model predictions

GetRulesets

List the rulesets approximating a model generated by DataRobot Prime

GetSeriesAccuracy

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

GetPrimeEligibility

Check if model can be approximated with DataRobot Prime

GetParetoFront

Pareto Front data for a Eureqa model

GetServerDataInRows

Handle server side pagination.

GetFeatureImpactForJobId

Retrieve completed Feature Impact results given a job ID

GetModelingFeaturelist

Retrieve a specific modeling featurelist from a DataRobot project

GetModelRecommendation

Retrieve a model recommendation from DataRobot for your project.

GetPredictionDataset

Retrieve data on a prediction dataset

GetPredictionExplanationsMetadata

Retrieve metadata for specified prediction explanations

GetPredictionExplanations

Get prediction explanations

GetPrimeModel

Retrieve information about specified DataRobot Prime model.

GetPredictionExplanationsMetadataFromJobId

Retrieve the prediction explanations metadata for a model using jobId

GetTrainingPredictionsFromJobId

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

GetPrimeModelFromJobId

Retrieve information about specified DataRobot Prime model using corresponding jobId.

ListComplianceDocTemplates

Retrieve information about all compliance doc templates.

JobType

Job type

ListAnomalyAssessmentRecords

Retrieve anomaly assessment records.

GetTransferableModel

Retrieve imported model info using import id

ListDeployments

List all current model deployments.

ListModelJobs

Retrieve status of Autopilot modeling jobs that are not complete

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.

ListRatingTables

Retrieve information about all rating tables.

Retrieve details about a specified DataRobot modeling project

ListDataStores

Returns a dataframe with information on available data stores.

ListDataSources

Returns a dataframe with information on available data sources.

GetProjectStatus

Request Autopilot status for a specified DataRobot project

ProjectFromJobResponse

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

PrimeLanguage

Prime Language

GetRecommendedModel

Retrieve the model object that DataRobot recommends for your project.

RequestBlender

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

ListConfusionCharts

Returns all available confusion charts for the model.

ListTransferableModels

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

ListTrainingPredictions

Retrieve information about all training prediction datasets in a project.

PauseQueue

Pause the DataRobot modeling queue

PeriodicityMaxTimeStep

Periodicity max time step

ReplaceDeployedModel

Replace a model in a deployment with another model.

GetValidMetrics

Retrieve the valid fitting metrics for a specified project and target

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.

GetTuningParameters

Retrieve data on tuning parameters for a particular model.

GetWordCloud

Retrieve word cloud data for a model.

GetResidualsChart

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

RequestCrossSeriesDetection

Format a cross series with group by columns.

RequestPredictionExplanationsInitialization

Request prediction explanations initialization for specified model

ListPredictionExplanationsMetadata

Retrieve metadata for prediction explanations in specified project

ListDrivers

Returns a dataframe with information on available drivers.

RequestPredictions

Request predictions from a model against a previously uploaded dataset

ListPredictionServers

List all available prediction servers.

InitializeAnomalyAssessment

Request anomaly assessment insight computation on the specified subset.

GetTimeSeriesFeatureDerivationLog

Retrieve the time series feature derivation log content

GetRocCurve

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

MulticlassDeploymentAccuracyMetric

Accuracy metrics for multiclass deployments

ModelReplacementReason

Model replacement reason

ListPredictions

Fetch all computed predictions for a project.

ListPrimeFiles

List all downloadable code files from DataRobot Prime for the project

ProjectStage

Project stage

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.

RequestFrozenModel

Train a new frozen model with parameters from specified model

RFC3339DateTimeFormat

RFC 3339 datetime format

RequestApproximation

Request an approximation of a model using DataRobot Prime

SeriesAggregationType

Series aggregation type

SegmentAnalysisAttribute

Segment analysis attributes

StartProject

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

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.

RequestPrimeModel

Request training for a DataRobot Prime model using a specified ruleset

RequestSampleSizeUpdate

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

RequestMultiSeriesDetection

Format a multiseries.

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)

SharingRole

Sharing role

ListFeatureInfo

Details about all features for this project

ListModels

Retrieve all available model information for a DataRobot project

ListFeaturelists

Retrieve all featurelists associated with a project

PeriodicityTimeUnits

Periodicity time units

ListPredictionDatasets

Retrieve all prediction datasets associated with a project

ListSharingAccess

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

PostgreSQLdrivers

PostgreSQL drivers

IsBlenderEligible

Check whether individual models can be blended together

ListStarredModels

List all the starred models in a project.

SourceType

Source types

UploadComplianceDocTemplate

Upload a compliance doc template.

UnstarModel

Unstar a model.

UnpauseQueue

Re-start the DataRobot modeling queue

as.dataRobotFeatureInfo

Information on a data feature.

UpdateTransferableModel

Update the display name or note for an imported model.

as.dataRobotDeploymentAssociationIdSettings

Association ID settings for a deployment.

RecommendedModelType

Recommended model type values

RequestFrozenDatetimeModel

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

RequestFeatureImpact

Request Feature Impact to be computed.

RequestTransferableModel

Request creation of a transferable model

TestDataStore

Test the database connection to the data store.

TargetType

Target Type modes

SetPredictionThreshold

Set a custom prediction threshold for binary classification models.

IsId

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

ListJobs

Retrieve information about jobs

ListModelingFeaturelists

Retrieve all modeling featurelists associated with a project

ListLiftCharts

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

ListModelRecommendations

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

RunInteractiveTuning

Run an interactive model tuning session.

ListPrimeModels

Retrieve information about all DataRobot Prime models for a DataRobot project

ReformatMetrics

replace NULL in $metrics list elements with NA

RequestNewDatetimeModel

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

StarModel

Star a model.

SetTarget

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

RequestTrainingPredictions

Request training predictions for a specific model.

RequestSeriesAccuracy

Compute the series accuracy for a model.

RequestNewModel

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

UpdateAccess

Update access to a particular object.

UpdateCalendar

Update a calendar

UpdateDeploymentDriftTrackingSettings

Update drift tracking settings for a deployment.

UpdateDataStore

Update a data store.

UploadPredictionDatasetFromDataSource

Upload a prediction dataset from a data source.

SetupProject

Function to set up a new DataRobot project

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.

UploadTransferableModel

Import a previously exported model for predictions.

UpdateComplianceDocTemplate

Update the name or sections of an existing doc template.

UploadPredictionDataset

Function to upload new data to a DataRobot project for predictions

SetupProjectFromDataSource

Create a project from a data source.

UploadData

Upload a data source.

as.data.frame

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

WaitForJobToComplete

Wait for specified job to complete

SetupProjectFromHDFS

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

ValidateModel

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

UpdateDataSource

Update a data store.

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.

cvMethods

CV methods

ValidateMultiSeriesProperties

Validate that the multiseries properties indicate a successful multiseries setup.

datarobot-package

datarobot: 'DataRobot' Predictive Modeling API

summary.dataRobotModel

DataRobot S3 object methods for R's generic summary function

reorderColumns

Reorder the columns in a data.frame

Share a shareable object with a particular user.

ListProjects

Retrieve a list of all DataRobot projects

UpdateDeploymentSettings

Updates configuration settings for a deployed model.

PredictionDatasetFromAsyncUrl

Retrieve prediction dataset info from the dataset creation URL

Predict

Retrieve model predictions

RegressionDeploymentAccuracyMetric

Accuracy metrics for regression deployments

RequestNewRatingTableModel

Create a new model from a rating table.

RenameRatingTable

Renames a rating table to a different name.

UpdateFeaturelist

Update a featurelist

ValidateActuals

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

ValidateCalendar

Get a calendar id from a calendar object.

VariableTransformTypes

Types of variable transformations

ScaleoutModelingMode

Scaleout modeling modes

RequestPredictionExplanations

Request prediction explanations computation for a specified model and dataset.

ScoreBacktests

Compute the scores for all available backtests.

summary.listOfDataRobotTuningParameters

Summarize the list of tuning parameters available for a model.

tidyServiceOverTimeObject

Tidies a ServiceOverTime response object for use in a DF

ViewWebModel

Retrieve a DataRobot web page that displays detailed model information

StartTuningSession

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

Stringify

Convert a function into a single string for DataRobot

TargetLeakageType

Target leakage report values

TryingToSubmitNull

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

SubmitActuals

Submit actuals for processing.

TreatAsExponential

Treat as exponential

ValidateParameterIn

Ensure a parameter is valid

ValidatePartition

Checks if a partition is valid.

plot.listOfModels

Plot method for DataRobot S3 objects of class listOfModels

predict.dataRobotModel

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

TimeUnits

Time units

UpdateModelingFeaturelist

Update a modeling featurelist

ToggleStarForModel

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

UpdateProject

Update parameters for an existing project

ValidateReplaceDeployedModel

Validate a potential deployment model replacement.

as.dataRobotMultiSeriesProperties

Return value for GetMultiSeriesProperties() and others

ValidateProject

Get a projectId from a project object.

parseRFC3339Timestamp

as.dataRobotProjectShort

Return value for SetupProject() and others

formatRFC3339Timestamp

validateReportingPeriodTime

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

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