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

datarobot (version 2.16.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.16.0

License

MIT + file LICENSE

Maintainer

David Chudzicki

Last Published

January 7th, 2020

Functions in datarobot (2.16.0)

CreateComplianceDocumentation

Create compliance documentation from a model.
CreateDataSource

Create a data source.
ConstructDurationString

Construct a valid string representing a duration in accordance with ISO8601
ConnectToDataRobot

Establish a connection to the DataRobot modeling engine
CreateDataStore

Create a data store.
CreateDatetimePartitionSpecification

Create a list describing datetime partition parameters
DeleteComplianceDocTemplate

Deletes a compliance doc template.
DataPathFromDataArg

Get the data path.
DataPartition

Data Partition methods
DeletePredictJob

Function to delete one predict job from the DataRobot queue
DeleteDataStore

Delete a data store.
DownloadComplianceDocTemplate

Download a compliance doc template (in JSON format).
DeleteFeaturelist

Delete a featurelist
DeleteDataSource

Delete a data store.
DeletePredictionDataset

Delete a specified prediction dataset
DownloadComplianceDocumentation

Download compliance documentation (in DOCX format).
BlueprintChartToGraphviz

Convert a blueprint chart into graphviz DOT format
DownloadPredictionExplanations

Function to download and save prediction explanations rows as csv file
GetBlenderModelFromJobId

Retrieve a new or updated blender model defined by modelJobId
GetBlenderModel

Retrieve the details of a specified blender model
DownloadPrimeCode

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

Reformat paginated data returned from the server.
FeatureFromAsyncUrl

Retrieve a feature from the creation URL
GetBlueprint

Retrieve a blueprint
GetCalendarFromProject

Retrieve the calendar for a particular project.
GenerateDatetimePartition

Preview the full partitioning determined by a DatetimePartitioningSpecification
CreateGroupPartition

Create a group-based S3 object of class partition for the SetTarget function
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
DataSubset

Data subset for training predictions
DeleteCalendar

Delete a calendar
GetMissingValuesReport

Get a report on missing values for the model.
GetDatetimeModelFromJobId

Retrieve a new or updated datetime model defined by modelJobId
GetDatetimeModel

Retrieve the details of a specified datetime model.
GetBlueprintChart

Retrieve a blueprint chart
GetLiftChart

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

Retrieve model parameters
GetComplianceDocTemplate

Get a compliance doc template.
GetDataStoreSchemas

Get the schemas associated with a data store.
DeleteTransferableModel

Delete this imported model.
DeleteModel

Delete a specified DataRobot model
GetDataSource

Returns information about a particular data source.
DownloadTimeSeriesFeatureDerivationLog

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

Delete a specified element from the DataRobot project list
DeleteJob

Cancel a running job
DownloadSeriesAccuracy

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

Retrieve a model recommendation from DataRobot for your project.
GetDataStore

Returns information about a particular data store.
GetDataStoreTables

Get all tables associated with a data store.
GetFeatureHistogram

Retrieve histogram plot data for a specific feature
GetFrozenModelFromJobId

Retrieve a frozen model defined by modelJobId
GetFeatureImpact

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

Create a calendar from an uploaded CSV.
GetFrozenModel

Retrieve the details of a specified frozen model
CreateBacktestSpecification

Create a list describing backtest parameters
GetPredictionExplanationsMetadataFromJobId

Retrieve the prediction explanations metadata for a model using jobId
GetPredictionExplanationsRows

Retrieve all prediction explanations rows
GetModelingFeaturelist

Retrieve a specific modeling featurelist from a DataRobot project
GetPrimeModel

Retrieve information about specified DataRobot Prime model.
GetRecommendedModel

Retrieve the model object that DataRobot recommends for your project.
GetPrimeFileFromJobId

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

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

Retrieve time series properties for a potential multiseries datetime partition column
CreatePrimeCode

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

Get a rating table from the rating table job metadata.
GetPredictions

Retrieve model predictions
GetPredictionExplanationsRowsAsDataFrame

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

Retrieve data on tuning parameters for a particular model.
GetRocCurve

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

Retrieve word cloud data for a model.
GetRulesets

List the rulesets approximating a model generated by DataRobot Prime
GetRatingTableModel

Retrieve information about specified model with a rating table.
GetValidMetrics

Retrieve the valid fitting metrics for a specified project and target
GetGeneralizedInsight

An internal function to help fetch insights.
CreateFeaturelist

Create a new featurelist in a DataRobot project
CreateDerivedFeatures

Derived Features
BlendMethods

Blend methods
GetJob

Request information about a job
AutopilotMode

Autopilot modes
IsBlenderEligible

Check whether individual models can be blended together
DeletePredictionExplanations

Function to delete prediction explanations
CreateRandomPartition

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

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

Delete the prediction explanations initialization for a model.
CreateRatingTable

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

Delete this imported model.
DifferencingMethod

Differencing method
ListCalendars

List all available calendars.
ListDataSources

Returns a dataframe with information on available data sources.
ListBlueprints

Retrieve the list of available blueprints for a project
CreateUserPartition

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

Retrieve information about all DataRobot models with a rating table.
DownloadTransferableModel

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

Make a HTTP request
ListRatingTables

Retrieve information about all rating tables.
PauseQueue

Pause the DataRobot modeling queue
ListDataStores

Returns a dataframe with information on available data stores.
ListModelFeatures

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

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

Download training predictions on a specified data set.
ListPredictionDatasets

Retrieve all prediction datasets associated with a project
GetParetoFront

Pareto Front data for a Eureqa model
GetConfusionChart

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

Handle server side pagination.
GetPredictionExplanationsInitialization

Retrieve the prediction explanations initialization for a model.
GetTimeSeriesFeatureDerivationLog

Retrieve the time series feature derivation log content
GetTrainingPredictionsForModel

Get training predictions for a particular model.
GetPrimeModelFromJobId

Retrieve information about specified DataRobot Prime model using corresponding jobId.
GetTrainingPredictionsFromJobId

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

Get prediction explanations
GetProject

Retrieve details about a specified DataRobot modeling project
GetPredictJob

Request information about a predict job
ListDrivers

Returns a dataframe with information on available drivers.
ListFeatureInfo

Details about all features for this project
GetPredictJobs

Function to list all prediction jobs in a project
GetFeatureInfo

Details about a feature
GetDatetimePartition

Retrieve the DatetimePartitioning from a project
GetModelFromJobId

Retrieve a new or updated model defined by modelJobId
GetDriver

Returns information about a particular driver.
ListModelingFeaturelists

Retrieve all modeling featurelists associated with a project
GetCrossValidationScores

Get cross validation scores
GetModelJob

Request information about a single model job
GetFeaturelist

Retrieve a specific featurelist from a DataRobot project
ListPredictionExplanationsMetadata

Retrieve metadata for prediction explanations in specified project
CrossValidateModel

Run cross validation on a model.
GetPredictionDataset

Retrieve data on a prediction dataset
DeleteModelingFeaturelist

Delete a modeling featurelist
DownloadRatingTable

Download a rating table to a CSV.
DeleteModelJob

Delete a model job from the modeling queue
ListPrimeModels

Retrieve information about all DataRobot Prime models for a DataRobot project
ListProjects

Retrieve a list of all DataRobot projects
Predict

Retrieve model predictions
RequestBlender

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

PostgreSQL drivers
ListModels

Retrieve all available model information for a DataRobot project
RequestFeatureImpact

Request Feature Impact to be computed.
RequestCrossSeriesDetection

Format a cross series with group by columns.
DownloadScoringCode

Download scoring code JAR
RequestNewDatetimeModel

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

Adds a new model of type specified by blueprint to a DataRobot 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.
GetPrimeEligibility

Check if model can be approximated with DataRobot Prime
ScoreBacktests

Compute the scores for all available backtests.
PredictionDatasetFromAsyncUrl

Retrieve prediction dataset info from the dataset creation URL
DownloadTransferrableModel

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

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

Function to set up a new DataRobot project using data from Oracle table (deprecated)
SetupProjectFromPostgreSQL

Function to set up a new DataRobot project using data from PostgreSQL table (deprecated)
TryingToSubmitNull

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

Series aggregation type
Stringify

Convert a function into a single string for DataRobot
PrimeLanguage

Prime Language
GetPrimeFile

Retrieve a specific Prime file from a DataRobot project
RequestFrozenDatetimeModel

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

Re-start the DataRobot modeling queue
GetTrainingPredictionDataFrame

Simplify the training prediction rows into a tidy format dataframe.
RequestFrozenModel

Train a new frozen model with parameters from specified model
GetTransferableModel

Retrieve imported model info using import id
GetTransferrableModel

Retrieve imported model info using import id
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).
GetTrainingPredictions

Retrieve training predictions on a specified data set.
GetBlueprintDocumentation

Get documentation for tasks used in the blueprint
GetCalendar

Retrieve a calendar
RequestMultiSeriesDetection

Format a multiseries.
JobStatus

Job statuses
JobType

Job type
ListPrimeFiles

List all downloadable code files from DataRobot Prime for the project
ListJobs

Retrieve information about jobs
PeriodicityTimeUnits

Periodicity time units
ListFeaturelists

Retrieve all featurelists associated with a project
RecommendedModelType

Recommended model type values
ListPredictions

Fetch all computed predictions for a project.
PeriodicityMaxTimeStep

Periodicity max time step
GetFeatureImpactForJobId

Retrieve completed Feature Impact results given a job ID
ReformatMetrics

replace NULL in $metrics list elements with NA
ProjectFromAsyncUrl

Retrieve a project from the project-creation URL
RequestSeriesAccuracy

Compute the series accuracy for a model.
StarModel

Star a model.
RequestTrainingPredictions

Request training predictions for a specific model.
ToggleStarForModel

Star a model if it is unstarred, otherwise unstar the model.
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.
ProjectStage

Project stage
RequestPredictionExplanationsInitialization

Request prediction explanations initialization for specified model
GetFeatureImpactForModel

Retrieve completed Feature Impact results given a model
RequestPredictionExplanations

Request prediction explanations computation for a specified model and dataset.
ValidatePartition

Checks if a partition is valid.
RequestNewRatingTableModel

Create a new model from a rating table.
ValidateParameterIn

Ensure a parameter is valid
RunInteractiveTuning

Run an interactive model tuning session.
UpdateTransferrableModel

Update the display name or note for an imported model.
plot.listOfModels

Plot method for DataRobot S3 objects of class listOfModels
UploadComplianceDocTemplate

Upload a compliance doc template.
GetModel

Retrieve the details of a specified model
UpdateDataStore

Update a data store.
ScaleoutModelingMode

Scaleout modeling modes
SharingRole

Sharing role
ViewWebProject

Retrieve a DataRobot web page that displays detailed project information
UpdateModelingFeaturelist

Update a modeling featurelist
TestDataStore

Test the database connection to the data store.
Share

Share a shareable object with a particular user.
TimeUnits

Time units
UploadData

Upload a data source.
UploadPredictionDataset

Function to upload new data to a DataRobot project for predictions
UpdateFeaturelist

Update a featurelist
RequestPredictions

Request predictions from a model against a previously uploaded dataset
predict.dataRobotModel

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

This function periodically checks whether Autopilot is finished and returns only after it is.
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.
datarobot-package

datarobot: 'DataRobot' Predictive Modeling API
SetPredictionThreshold

Set a custom prediction threshold for binary classification models.
WaitForJobToComplete

Wait for specified job to complete
SetTarget

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

Function to set up a new DataRobot project
StartProject

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

Create a project from a data source.
ValidateModel

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

Import a previously exported model for predictions.
UploadPredictionDatasetFromDataSource

Upload a prediction dataset from a data source.
UpdateDataSource

Update a data store.
TreatAsExponential

Treat as exponential
UnstarModel

Unstar a model.
GetModelBlueprintChart

Retrieve a model blueprint chart
ValidateMultiSeriesProperties

Validate that the multiseries properties indicate a successful multiseries setup.
UploadTransferrableModel

Import a previously exported model for predictions.
UpdateAccess

Update access to a particular object.
as.data.frame

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

Get a calendar id from a calendar object.
cvMethods

CV methods
GetModelBlueprintDocumentation

Get documentation for tasks used in the model blueprint
GetModelCapabilities

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

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

Retrieve metadata for specified prediction explanations
IsId

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

Request Autopilot status for a specified DataRobot project
GetRatingTable

Retrieve a single rating table.
GetPredictionExplanationsInitializationFromJobId

Retrieve the prediction explanations initialization for a model using jobId
GetSeriesAccuracyForModel

Get the series accuracy associated with a particular model.
IsParameterIn

Check if a parameter is in a list of possibilities.
ListModelJobs

Retrieve status of Autopilot modeling jobs that are not complete
ListStarredModels

List all the starred models in a project.
ListComplianceDocTemplates

Retrieve information about all compliance doc templates.
ListModelRecommendations

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

Returns all available confusion charts for the model.
ListTrainingPredictions

Retrieve information about all training prediction datasets in a project.
ListTransferrableModels

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

Renames a rating table to a different name.
ListTransferableModels

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

Request an approximation of a model using DataRobot Prime
RequestPrimeModel

Request training for a DataRobot Prime model using a specified ruleset
ValidateProject

Get a projectId from a project object.
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.
RequestSampleSizeUpdate

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

Request generation of an transferrable 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 DownloadTransferrableModel for that.
SetupProjectFromHDFS

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

Function to set up a new DataRobot project using data from MySQL table (deprecated)
UpdateProject

Update parameters for an existing project
TargetType

Target Type modes
UpdateCalendar

Update a calendar
TargetLeakageType

Target leakage report values
UpdateComplianceDocTemplate

Update the name or sections of an existing doc template.
summary.dataRobotModel

DataRobot S3 object methods for R's generic summary function
UpdateTransferableModel

Update the display name or note for an imported model.
ViewWebModel

Retrieve a DataRobot web page that displays detailed model information
summary.listOfDataRobotTuningParameters

Summarize the list of tuning parameters available for a model.
AddEureqaSolution

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

Apply a schema to DataRobot objects (lists, frames)