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

datarobot (version 2.17.1)

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

License

MIT + file LICENSE

Maintainer

David Chudzicki

Last Published

July 1st, 2020

Functions in datarobot (2.17.1)

CheckUrl

Make sure the path is a reasonable URL

BlueprintChartToGraphviz

Convert a blueprint chart into graphviz DOT format

ApplySchema

Apply a schema to DataRobot objects (lists, frames)

ConnectToDataRobot

Establish a connection to the DataRobot modeling engine

CleanServerData

Reformat paginated data returned from the server.

AddEureqaSolution

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

ConstructDurationString

Construct a valid string representing a duration in accordance with ISO8601

AutopilotMode

Autopilot modes

BatchFeaturesTypeTransform

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

CreateDatetimePartitionSpecification

Create a list describing datetime partition parameters

CreateDerivedFeatures

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

CreateDataSource

Create a data source.

CreateStratifiedPartition

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

CreateComplianceDocumentation

Create compliance documentation from a model.

DeleteModelingFeaturelist

Delete a modeling featurelist

CreateUserPartition

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

DeleteModelJob

Delete a model job from the modeling queue

DataPathFromDataArg

Get the data path.

CrossValidateModel

Run cross validation on a model.

DownloadRatingTable

Download a rating table to a CSV.

DownloadComplianceDocumentation

Download compliance documentation (in DOCX format).

CreateFeaturelist

Create a new featurelist in a DataRobot project

DownloadTimeSeriesFeatureDerivationLog

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

GetConfusionChart

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

GetDeploymentDriftTrackingSettings

Get drift tracking settings for a deployment.

DownloadPredictionExplanations

Function to download and save prediction explanations rows as csv file

DownloadTrainingPredictions

Download training predictions on a specified data set.

GetCrossValidationScores

Get cross validation scores

GetDriver

Returns information about a particular driver.

DataSubset

Data subset for training predictions

DataPartition

Data Partition methods

GetFeatureHistogram

Retrieve histogram plot data for a specific feature

DeleteDeployment

Delete a deployment.

CreatePrimeCode

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

DeleteFeaturelist

Delete a featurelist

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

DeleteJob

Cancel a running job

DeleteModel

Delete a specified DataRobot model

DeleteProject

Delete a specified element from the DataRobot project list

CreateGroupPartition

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

DeleteCalendar

Delete a calendar

DeleteTransferableModel

Delete this imported model.

DifferencingMethod

Differencing method

DeleteComplianceDocTemplate

Deletes a compliance doc template.

DeletePredictionExplanations

Function to delete prediction explanations

CreateCalendar

Create a calendar from an uploaded CSV.

DeleteDataSource

Delete a data store.

CreateBacktestSpecification

Create a list describing backtest parameters

CreateRatingTable

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

CreateRandomPartition

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

GetDataStoreSchemas

Get the schemas associated with a data store.

DownloadComplianceDocTemplate

Download a compliance doc template (in JSON format).

DeleteDataStore

Delete a data store.

DeletePredictJob

Function to delete one predict job from the DataRobot queue

GetFeatureImpact

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

DownloadScoringCode

Download scoring code JAR

GetDataStore

Returns information about a particular data store.

GetFrozenModelFromJobId

Retrieve a frozen model defined by modelJobId

GetModelBlueprintChart

Retrieve a model blueprint chart

GetBlueprintChart

Retrieve a blueprint chart

GetDataSource

Returns information about a particular data source.

GetModel

Retrieve the details of a specified model

GetBlueprint

Retrieve a blueprint

GetModelingFeaturelist

Retrieve a specific modeling featurelist from a DataRobot project

GetFrozenModel

Retrieve the details of a specified frozen model

GetMultiSeriesProperties

Retrieve time series properties for a potential multiseries datetime partition column

DeletePredictionExplanationsInitialization

Delete the prediction explanations initialization for a model.

DownloadTransferableModel

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

GetDataStoreTables

Get all tables associated with a data store.

GetParetoFront

Pareto Front data for a Eureqa model

GetPredictJob

Request information about a predict job

GetPredictionExplanationsInitializationFromJobId

Retrieve the prediction explanations initialization for a model using jobId

GetPredictionExplanationsMetadata

Retrieve metadata for specified prediction explanations

GetJob

Request information about a job

GetGeneralizedInsight

An internal function to help fetch insights.

GetPredictionExplanationsInitialization

Retrieve the prediction explanations initialization for a model.

GetPredictionExplanations

Get prediction explanations

GetPredictionExplanationsRowsAsDataFrame

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

GetPredictions

Retrieve model predictions

DownloadSeriesAccuracy

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

GetPrimeEligibility

Check if model can be approximated with DataRobot Prime

FeatureFromAsyncUrl

Retrieve a feature from the creation URL

GetCalendarFromProject

Retrieve the calendar for a particular project.

GetDatetimeModel

Retrieve the details of a specified datetime model.

DeletePredictionDataset

Delete a specified prediction dataset

GetComplianceDocTemplate

Get a compliance doc template.

GenerateDatetimePartition

Preview the full partitioning determined by a DatetimePartitioningSpecification

GetDatetimeModelFromJobId

Retrieve a new or updated datetime model defined by modelJobId

GetFeatureAssociationMatrix

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

GetPrimeModelFromJobId

Retrieve information about specified DataRobot Prime model using corresponding jobId.

GetProject

Retrieve details about a specified DataRobot modeling project

GetPrimeFile

Retrieve a specific Prime file from a DataRobot project

GetRatingTableModelFromJobId

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

GetDatetimePartition

Retrieve the DatetimePartitioning from a project

GetFeatureImpactForJobId

Retrieve completed Feature Impact results given a job ID

GetRecommendedModel

Retrieve the model object that DataRobot recommends for your project.

GetDeployment

Get information on a particular deployment.

GetBlenderModel

Retrieve the details of a specified blender model

GetBlenderModelFromJobId

Retrieve a new or updated blender model defined by modelJobId

GetValidMetrics

Retrieve the valid fitting metrics for a specified project and target

GetWordCloud

Retrieve word cloud data for a model.

GetRatingTableFromJobId

Get a rating table from the rating table job metadata.

GetRatingTableModel

Retrieve information about specified model with a rating table.

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

GetSeriesAccuracyForModel

Get the series accuracy associated with a particular model.

ListComplianceDocTemplates

Retrieve information about all compliance doc templates.

GetSeriesAccuracy

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

ListCalendars

List all available calendars.

GetTrainingPredictions

Retrieve training predictions on a specified data set.

IsId

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

GetTrainingPredictionDataFrame

Simplify the training prediction rows into a tidy format dataframe.

IsBlenderEligible

Check whether individual models can be blended together

GetFeatureAssociationMatrixDetails

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

GetModelBlueprintDocumentation

Get documentation for tasks used in the model blueprint

ListFeatureInfo

Details about all features for this project

ListDrivers

Returns a dataframe with information on available drivers.

ListPrimeFiles

List all downloadable code files from DataRobot Prime for the project

ListSharingAccess

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

ListPrimeModels

Retrieve information about all DataRobot Prime models for a DataRobot project

GetModelCapabilities

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

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)

GetTransferableModel

Retrieve imported model info using import id

ListModelingFeaturelists

Retrieve all modeling featurelists associated with a project

ListStarredModels

List all the starred models in a project.

ProjectStage

Project stage

ListLiftCharts

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

RecommendedModelType

Recommended model type values

GetLiftChart

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

GetFeatureImpactForModel

Retrieve completed Feature Impact results given a model

GetMissingValuesReport

Get a report on missing values for the model.

GetModelParameters

Retrieve model parameters

GetModelRecommendation

Retrieve a model recommendation from DataRobot for your project.

JobStatus

Job statuses

GetBlueprintDocumentation

Get documentation for tasks used in the blueprint

IsParameterIn

Check if a parameter is in a list of possibilities.

GetTuningParameters

Retrieve data on tuning parameters for a particular model.

ListModelFeatures

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

ListFeaturelists

Retrieve all featurelists associated with a project

GetCalendar

Retrieve a calendar

GetFeatureInfo

Details about a feature

ReformatMetrics

replace NULL in $metrics list elements with NA

ListModels

Retrieve all available model information for a DataRobot project

Share a shareable object with a particular user.

TestDataStore

Test the database connection to the data store.

SeriesAggregationType

Series aggregation type

RequestPredictionExplanationsInitialization

Request prediction explanations initialization for specified model

RenameRatingTable

Renames a rating table to a different name.

SetPredictionThreshold

Set a custom prediction threshold for binary classification models.

RequestPredictions

Request predictions from a model against a previously uploaded dataset

UpdateDeploymentDriftTrackingSettings

Update drift tracking settings for a deployment.

Retrieve a specific featurelist from a DataRobot project

RequestMultiSeriesDetection

Format a multiseries.

ModelReplacementReason

Model replacement reason

RequestNewDatetimeModel

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

RequestFrozenModel

Train a new frozen model with parameters from specified model

MakeDataRobotRequest

Make a HTTP request

ValidatePartition

Checks if a partition is valid.

GetPrimeFileFromJobId

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

as.data.frame

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

UpdateFeaturelist

Update a featurelist

ValidateProject

Get a projectId from a project object.

ListModelJobs

Retrieve status of Autopilot modeling jobs that are not complete

cvMethods

CV methods

GetRatingTable

Retrieve a single rating table.

GetModelJob

Request information about a single model job

GetPredictionDataset

Retrieve data on a prediction dataset

GetPredictionExplanationsMetadataFromJobId

Retrieve the prediction explanations metadata for a model using jobId

GetProjectStatus

Request Autopilot status for a specified DataRobot project

GetPredictionExplanationsRows

Retrieve all prediction explanations rows

GetModelFromJobId

Retrieve a new or updated model defined by modelJobId

GetPredictJobs

Function to list all prediction jobs in a project

GetPrimeModel

Retrieve information about specified DataRobot Prime model.

ListModelRecommendations

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

RequestNewModel

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

ListRatingTableModels

Retrieve information about all DataRobot models with a rating table.

ProjectFromAsyncUrl

Retrieve a project from the project-creation URL

RequestNewRatingTableModel

Create a new model from a rating table.

RequestPredictionExplanations

Request prediction explanations computation for a specified model and dataset.

ListProjects

Retrieve a list of all DataRobot projects

GetTrainingPredictionsForModel

Get training predictions for a particular model.

UpdateAccess

Update access to a particular object.

GetServerDataInRows

Handle server side pagination.

SetTarget

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

ListPredictionExplanationsMetadata

Retrieve metadata for prediction explanations in specified project

ListDeployments

List all current model deployments.

StarModel

Star a model.

SetupProject

Function to set up a new DataRobot project

ListPredictionDatasets

Retrieve all prediction datasets associated with a project

ListDataStores

Returns a dataframe with information on available data stores.

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

GetTrainingPredictionsFromJobId

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

ListJobs

Retrieve information about jobs

ListPredictionServers

List all available prediction servers.

ValidateModel

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

TreatAsExponential

Treat as exponential

ValidateCalendar

Get a calendar id from a calendar object.

ToggleStarForModel

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

ListTransferableModels

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

ListPredictions

Fetch all computed predictions for a project.

ListTrainingPredictions

Retrieve information about all training prediction datasets in a project.

PeriodicityTimeUnits

Periodicity time units

ListRatingTables

Retrieve information about all rating tables.

PostgreSQLdrivers

PostgreSQL drivers

UpdateTransferableModel

Update the display name or note for an imported model.

ReplaceDeployedModel

Replace a model in a deployment with another model.

RequestApproximation

Request an approximation of a model using DataRobot Prime

ScaleoutModelingMode

Scaleout modeling modes

UploadComplianceDocTemplate

Upload a compliance doc template.

Stringify

Convert a function into a single string for DataRobot

StartTuningSession

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

UpdateCalendar

Update a calendar

ScoreBacktests

Compute the scores for all available backtests.

ListRocCurves

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

UpdateModelingFeaturelist

Update a modeling featurelist

UpdateProject

Update parameters for an existing project

UpdateComplianceDocTemplate

Update the name or sections of an existing doc template.

WaitForAutopilot

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

PauseQueue

Pause the DataRobot modeling queue

WaitForJobToComplete

Wait for specified job to complete

JobType

Job type

GetTimeSeriesFeatureDerivationLog

Retrieve the time series feature derivation log content

ListBlueprints

Retrieve the list of available blueprints for a project

PredictionDatasetFromAsyncUrl

Retrieve prediction dataset info from the dataset creation URL

ListDataSources

Returns a dataframe with information on available data sources.

Predict

Retrieve model predictions

ListConfusionCharts

Returns all available confusion charts for the model.

PeriodicityMaxTimeStep

Periodicity max time step

RequestFeatureImpact

Request Feature Impact to be computed.

ValidateReplaceDeployedModel

Validate a potential deployment model replacement.

RequestFrozenDatetimeModel

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

ViewWebModel

Retrieve a DataRobot web page that displays detailed model information

VariableTransformTypes

Types of variable transformations

RequestBlender

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

RequestSeriesAccuracy

Compute the series accuracy for a model.

RequestTrainingPredictions

Request training predictions for a specific model.

RequestCrossSeriesDetection

Format a cross series with group by columns.

summary.listOfDataRobotTuningParameters

Summarize the list of tuning parameters available for a model.

ViewWebProject

Retrieve a DataRobot web page that displays detailed project information

RequestPrimeModel

Request training for a DataRobot Prime model using a specified ruleset

SetupProjectFromDataSource

Create a project from a data source.

RequestSampleSizeUpdate

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

SetupProjectFromHDFS

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

RequestTransferableModel

Request generation of an transferable model file for use in an on-premise DataRobot standalone prediction environment. This function can only be used if model export is enabled, and will only be useful if you have an on-premise environment in which to import it. This function does not download the exported file. Use DownloadTransferableModel for that.

RunInteractiveTuning

Run an interactive model tuning session.

TargetLeakageType

Target leakage report values

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

ValidateMultiSeriesProperties

Validate that the multiseries properties indicate a successful multiseries setup.

ValidateParameterIn

Ensure a parameter is valid

predict.dataRobotModel

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

UploadPredictionDataset

Function to upload new data to a DataRobot project for predictions

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.

TryingToSubmitNull

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

UploadPredictionDatasetFromDataSource

Upload a prediction dataset from a data source.

UploadData

Upload a data source.

UploadTransferableModel

Import a previously exported model for predictions.

datarobot-package

datarobot: 'DataRobot' Predictive Modeling API

summary.dataRobotModel

DataRobot S3 object methods for R's generic summary function

plot.listOfModels

Plot method for DataRobot S3 objects of class listOfModels