Unlimited learning, half price | 50% off

Last chance! 50% off unlimited learning

Sale ends in

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

datarobot (version 2.13.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.13.0

License

MIT + file LICENSE

Maintainer

David Chudzicki

Last Published

May 24th, 2019

Functions in datarobot (2.13.0)

CreateDataSource

Create a data source.
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
DeleteModel

Delete a specified DataRobot model
DeletePredictionExplanations

Function to delete prediction explanations
DeleteJob

Cancel a running job
DeletePredictionExplanationsInitialization

Delete the prediction explanations initialization for a model.
DownloadPredictionExplanations

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

Retrieve a new or updated blender model defined by modelJobId
DifferencingMethod

Differencing method
CreatePrimeCode

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

Retrieve a blueprint
CreateRatingTable

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

Retrieve the details of a specified datetime model.
CreateDataStore

Create a data store.
CreateDatetimePartitionSpecification

Create a list describing datetime partition parameters
DataPathFromDataArg

Get the data path.
CreateDerivedFeatures

Derived Features
DeleteModelJob

Delete a model job from the modeling queue
DataPartition

Data Partition methods
CreateFeaturelist

Create a new featurelist in a DataRobot project
CreateStratifiedPartition

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

Retrieve a new or updated datetime model defined by modelJobId
GetDriver

Returns information about a particular driver.
DownloadReasonCodes

Function to download and save reason codes rows as csv file (deprecated)
DeleteModelingFeaturelist

Delete a modeling featurelist
CreateRandomPartition

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

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

Retrieve a model blueprint chart
DataSubset

Data subset for training predictions
CreateUserPartition

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

Delete a data store.
DownloadScoringCode

Download scoring code JAR
GetModelBlueprintDocumentation

Get documentation for tasks used in the model blueprint
DeleteReasonCodesInitialization

Delete the reason codes initialization for a model (deprecated).
CrossValidateModel

Run cross validation on a model.
DeleteFeaturelist

Delete a featurelist
DeletePredictJob

Function to delete one predict job from the DataRobot queue
DeleteTransferrableModel

Delete this imported model.
GetAllLiftCharts

Retrieve lift chart data for a model for all available data partitions (deprecated)
DownloadTransferrableModel

Download an transferrable model file for use in an on-premise DataRobot standalone prediction environment.
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).
GetBlueprintChart

Retrieve a blueprint chart
DeletePredictionDataset

Delete a specified prediction dataset
DeleteDataSource

Delete a data store.
GetAllReasonCodesRowsAsDataFrame

Retrieve all reason codes rows and return them as a data frame (deprecated)
GetDatetimeModelObject

Get a datetime model object (deprecated).
GetBlueprintDocumentation

Get documentation for tasks used in the blueprint
GetPredictionExplanations

Get prediction explanations
GetPredictionDataset

Retrieve data on a prediction dataset
GetConfusionChart

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

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

Retrieve all prediction explanations rows
GetCrossValidationScores

Get cross validation scores
GetPredictionExplanationsRowsAsDataFrame

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

Download training predictions on a specified data set.
GetFrozenModel

Retrieve the details of a specified frozen model
FeatureFromAsyncUrl

Retrieve a feature from the creation URL
GetDataSource

Returns information about a particular data source.
GenerateDatetimePartition

Preview the full partitioning determined by a DatetimePartitioningSpecification
GetFrozenModelFromJobId

Retrieve a frozen model defined by modelJobId
GetDataStore

Returns information about a particular data store.
GetFeatureInfo

Details about a feature
GetProjectStatus

Request Autopilot status for a specified DataRobot project
GetModelFromJobId

Retrieve a new or updated model defined by modelJobId
GetFeaturelist

Retrieve a specific featurelist from a DataRobot project
GetMissingValuesReport

Get a report on missing values for the model.
GetJob

Request information about a job
GetDatetimePartition

Retrieve the DatetimePartitioning from a project
DeleteProject

Delete a specified element from the DataRobot project list
GetLiftChart

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

Retrieve a single rating table.
GetModel

Retrieve the details of a specified model
DeleteReasonCodes

Function to delete reason codes (deprecated)
GetPredictionExplanationsMetadata

Retrieve metadata for specified prediction explanations
GetTrainingPredictionsFromJobId

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

Request information about a single model job
DownloadPrimeCode

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

Retrieve the prediction explanations metadata for a model using jobId
GetPredictJob

Request information about a predict job
DownloadRatingTable

Download a rating table to a CSV.
GetAllRocCurves

Retrieve ROC curve data for a model for all available data partitions (deprecated version)
GetModelJobs

Retrieve status of Autopilot modeling jobs that are not complete (deprecated)
GetBlenderModel

Retrieve the details of a specified blender model
GetDataStoreSchemas

Get the schemas associated with a data store.
GetModelParameters

Retrieve model parameters
GetTransferrableModel

Retrieve imported model info using import id
GetProject

Retrieve details about a specified DataRobot modeling project
JobStatus

Job statuses
GetPredictJobs

Function to list all prediction jobs in a project
GetPrimeModel

Retrieve information about specified DataRobot Prime model.
GetPrimeModelFromJobId

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

Retrieve the prediction explanations initialization for a model.
JobType

Job type
GetProjectList

Retrieve a list of all DataRobot projects (deprecated version)
ListLiftCharts

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

Get all tables associated with a data store.
ListModelFeatures

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

Retrieve completed Feature Impact results given a job ID
GetFeatureImpactForModel

Retrieve completed Feature Impact results given a model
GetReasonCodesInitializationFromJobId

Retrieve the reason codes initialization for a model using jobId (deprecated)
ListPrimeModels

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

Retrieve a list of all DataRobot projects
GetReasonCodesMetadata

Retrieve metadata for specified reason codes (deprecated)
PeriodicityTimeUnits

Periodicity time units
GetPredictionExplanationsInitializationFromJobId

Retrieve the prediction explanations initialization for a model using jobId
GetRecommendedModel

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

Retrieve a model recommendedation from DataRobot for your project.
GetReasonCodesMetadataFromJobId

Retrieve the reason codes metadata for a model using jobId (deprecated)
PostgreSQLdrivers

PostgreSQL drivers
GetPrimeFile

Retrieve a specific Prime file from a DataRobot project
PrimeLanguage

Prime Language
ProjectFromAsyncUrl

Retrieve a project from the project-creation URL
GetReasonCodesRows

Retrieve all reason codes rows (deprecated)
GetModelingFeaturelist

Retrieve a specific modeling featurelist from a DataRobot project
GetMultiSeriesProperties

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

Retrieve the time series feature derivation log content
GetTrainingPredictionDataFrame

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

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

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

Returns a dataframe with information on available data sources.
GetParetoFront

Pareto Front data for a Eureqa model
ListDataStores

Returns a dataframe with information on available data stores.
GetWordCloud

Retrieve word cloud data for a model.
GetRatingTableModelFromJobId

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

Create a new model from a rating table.
GetPredictions

Retrieve model predictions
ListFeaturelists

Retrieve all featurelists associated with a project
IsBlenderEligible

Check whether individual models can be blended together
GetReasonCodesInitialization

Retrieve the reason codes initialization for a model (deprecated).
ListModelingFeaturelists

Retrieve all modeling featurelists associated with a project
GetTrainingPredictions

Retrieve training predictions on a specified data set.
RequestPredictionExplanations

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

Retrieve information about jobs
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.
ListModels

Retrieve all available model information for a DataRobot project
GetPrimeEligibility

Check if model can be approximated with DataRobot Prime
RunInteractiveTuning

Run an interactive model tuning session.
SetupProjectFromMySQL

Function to set up a new DataRobot project using data from MySQL table
SetupProjectFromHDFS

Function to set up a new DataRobot project using datasource on a WebHDFS server
GetTrainingPredictionsForModel

Get training predictions for a particular model.
ListBlueprints

Retrieve the list of available blueprints for a project
ListPredictionDatasets

Retrieve all prediction datasets associated with a project
ListRatingTableModels

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

Retrieve information about all rating tables.
ListPredictionExplanationsMetadata

Retrieve metadata for prediction explanations in specified project
ListConfusionCharts

Returns all available confusion charts for the model.
Predict

Retrieve model predictions
ListModelRecommendations

Retrieve information about model recommendedations made by DataRobot for your project.
ListModelJobs

Retrieve status of Autopilot modeling jobs that are not complete
ListPredictions

Fetch all computed predictions for a project.
UnpauseQueue

Re-start the DataRobot modeling queue
TreatAsExponential

Treat as exponential
PauseQueue

Pause the DataRobot modeling queue
ListPrimeFiles

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

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

Import a previously exported model for predictions.
PredictionDatasetFromAsyncUrl

Retrieve prediction dataset info from the dataset creation URL
ValidateModel

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

Retrieve information about specified model with a rating table.
PeriodicityMaxTimeStep

Periodicity max time step
datarobot-package

datarobot: 'DataRobot' Predictive Modeling API
GetRulesets

List the rulesets approximating a model generated by DataRobot Prime
plot.listOfModels

Plot method for DataRobot S3 objects of class listOfModels
GetServerDataInRows

Handle server side pagination.
GetTuningParameters

Retrieve data on tuning parameters for a particular model.
ProjectStage

Project stage
GetValidMetrics

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

Recommended model type values
RequestPredictionExplanationsInitialization

Request prediction explanations initialization for specified model
ListDrivers

Returns a dataframe with information on available drivers.
ListStarredModels

List all the starred models in a project.
ListTrainingPredictions

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

Request Feature Impact to be computed.
ListFeatureInfo

Details about all features for this project
RequestFrozenDatetimeModel

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

replace NULL in $metrics list elements with NA
RenameRatingTable

Renames a rating table to a different name.
RequestFrozenModel

Train a new frozen model with parameters from specified model
RequestPredictions

Request predictions against a previously uploaded dataset
ListReasonCodesMetadata

Retrieve metadata for reason codes in specified project (deprecated)
ListRocCurves

Retrieve ROC curve data for a model for all available data partitions (see DataPartition)
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
RequestMultiSeriesDetection

Format a multiseries.
ScaleoutModelingMode

Scaleout modeling modes
ScoreBacktests

Compute the scores for all available backtests.
ListTransferrableModels

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

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

Request reason codes computation for a specified model and dataset (deprecated).
SetupProject

Function to set up a new DataRobot project
RequestReasonCodesInitialization

Request reason codes initialization for specified model (deprecated)
SetupProjectFromOracle

Function to set up a new DataRobot project using data from Oracle table
MakeDataRobotRequest

Make a HTTP request
SetupProjectFromPostgreSQL

Function to set up a new DataRobot project using data from PostgreSQL table
SetupProjectFromDataSource

Create a project from a data source.
RequestApproximation

Request an approximation of a model using DataRobot Prime
RequestBlender

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

Request training predictions for a specific model.
StartProject

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

Test the database connection to the data store.
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.
UnstarModel

Unstar a model.
UpdateDataSource

Update a data store.
UpdateModelingFeaturelist

Update a modeling featurelist
ToggleStarForModel

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

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

Update a data store.
UpdateProject

Update parameters for an existing project
RequestPredictionsForDataset

Deprecated version of request predictions
WaitForAutopilot

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

Wait for specified job to complete
summary.listOfDataRobotTuningParameters

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

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

Update a featurelist
Stringify

Convert a function into a single string for DataRobot
UpdateTransferrableModel

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

Set a custom prediction threshold for binary classification models.
as.data.frame

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

Upload a data source.
cvMethods

CV methods
SetTarget

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

Retrieve a DataRobot web page that displays detailed model information
StarModel

Star a model.
ViewWebProject

Retrieve a DataRobot web page that displays detailed project information
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.
TargetLeakageType

Target leakage report values
predict.dataRobotModel

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

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

Target Type modes
UploadPredictionDataset

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

Upload a prediction dataset from a data source.
ValidateProject

Get a projectId from a project object.
ValidateParameterIn

Ensure a parameter is valid
AddEureqaSolution

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

Apply a schema to DataRobot objects (lists, frames)
CreateBacktestSpecification

Create a list describing backtest parameters
AutopilotMode

Autopilot modes
ConnectToDataRobot

Establish a connection to the DataRobot modeling engine
BlendMethods

Blend methods
ConstructDurationString

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

Convert a blueprint chart into graphviz DOT format
CleanServerData

Reformat paginated data returned from the server.