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

datarobot (version 2.9.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.9.0

License

MIT + file LICENSE

Maintainer

David Chudzicki

Last Published

September 11th, 2018

Functions in datarobot (2.9.0)

ConstructDurationString

Construct a valid string representing a duration in accordance with ISO8601

CreateBacktestSpecification

Create a list describing backtest parameters

CreateStratifiedPartition

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

CreateRandomPartition

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

CreateRatingTable

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

CreateUserPartition

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

DeleteReasonCodesInitialization

Delete the reason codes initialization for a model.

DeletePredictJob

Function to delete one predict job from the DataRobot queue

DeleteTransferrableModel

Delete this imported model.

BlendMethods

Blend methods

CleanServerData

Reformat paginated data returned from the server.

BlueprintChartToGraphviz

Convert a blueprint chart into graphviz DOT format

ConnectToDataRobot

Establish a connection to the DataRobot modeling engine

DeletePredictionDataset

Delete a specified prediction dataset

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

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

DownloadTransferrableModel

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

GetBlueprintDocumentation

Get documentation for tasks used in the blueprint

DownloadScoringCode

Download scoring code JAR

GetBlueprintDocuments

Get documentation for tasks used in the blueprint

CreatePrimeCode

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

DataPartition

Data Partition methods

FeatureFromAsyncUrl

Retrieve a feature from the creation URL

DownloadTrainingPredictions

Download training predictions on a specified data set.

GetFeatureImpactForJobId

Retrieve completed Feature Impact results given a job ID

GetJob

Request information about a job

GetLiftChart

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

GenerateDatetimePartition

Preview the full partitioning determined by a DatetimePartitioningSpecification

GetAllReasonCodesRowsAsDataFrame

Retrieve all reason codes rows and return them as a data frame

GetAllRocCurves

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

GetFeatureImpactForModel

Retrieve completed Feature Impact results given a model

DataPathFromDataArg

Get the data path.

DeleteProject

Delete a specified element from the DataRobot project list

GetPrimeFile

Retrieve a specific Prime file from a DataRobot project

GetPredictJob

Request information about a predict job

GetPredictJobs

Function to list all prediction jobs in a project

GetDatetimeModelObject

Retrieve the details of a specified datetime model.

GetProjectStatus

Request Autopilot status for a specified DataRobot project

DeleteReasonCodes

Function to delete reason codes

GetRatingTable

Retrieve a single rating table.

GetDatetimePartition

Retrieve the DatetimePartitioning from a project

GetPrimeFileFromJobId

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

GetModel

Retrieve the details of a specified model

GetModelBlueprintChart

Retrieve a model blueprint chart

GetTrainingPredictionDataFrame

Simplify the training prediction rows into a tidy format dataframe.

DifferencingMethod

Differencing method

DownloadPrimeCode

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

GetTrainingPredictions

Retrieve training predictions on a specified data set.

ListBlueprints

Retrieve the list of available blueprints for a project

GetModelJobs

Retrieve status of Autopilot modeling jobs that are not complete

GetPrimeModel

Retrieve information about specified DataRobot Prime model.

ListConfusionCharts

Returns all available confusion charts for the model.

GetModelObject

Retrieve the details of a specified model

ListPrimeFiles

List all downloadable code files from DataRobot Prime for the project

GetProject

Retrieve dtails about a specified DataRobot modeling project

ListPrimeModels

Retrieve information about all DataRobot Prime models for a DataRobot project

GetProjectList

Retrieve a list of all DataRobot projects

GetPrimeModelFromJobId

Retrieve information about specified DataRobot Prime model using corresponding jobId.

PeriodicityTimeUnits

Periodicity time units

CreateDatetimePartitionSpecification

Create a list describing datetime partition parameters

GetBlueprint

Retrieve a blueprint

GetReasonCodesInitializationFromJobId

Retrieve the reason codes initialization for a model using jobId

GetBlueprintChart

Retrieve a blueprint chart

JobType

Job type

ListModelFeatures

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

ListModelingFeaturelists

Retrieve all modeling featurelists associated with a project

GetFeatureInfo

Details about a feature

GetFeaturelist

Retrieve a specific featurelist from a DataRobot project

GetReasonCodesMetadata

Retrieve metadata for specified reason codes

PauseQueue

Pause the DataRobot modeling queue

CreateDerivedFeatures

Derived Features

GetModelBlueprintDocumentation

Get documentation for tasks used in the model blueprint

PeriodicityMaxTimeStep

Periodicity max time step

GetModelDeployment

Retrieve data on a specific model deployment.

RequestBlender

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

CreateFeaturelist

Create a new featurelist in a DataRobot project

RequestFeatureImpact

Request Feature Impact to be computed.

ListFeatureInfo

Details about all features for this project

GetRatingTableFromJobId

Get a rating table from the rating table job metadata.

RenameRatingTable

Renames a rating table to a different name.

ListFeaturelists

Retrieve all featurelists associated with a project

GetRatingTableModel

Retrieve information about specified model with a rating table.

GetRecommendedBlueprints

Retrieve the list of available blueprints for a project

GetRocCurve

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

CreateGroupPartition

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

DataSubset

Data subset for training predictions

DeleteJob

Cancel a running job

ListJobs

Retrieve information about jobs

RequestPrimeModel

Request training for a DataRobot Prime model using a specified ruleset

ListModelDeployments

Retrieve information about all model deployments throughout your projects.

RequestReasonCodes

Request reason codes computation for a specified model and dataset.

ListTransferrableModels

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

DownloadRatingTable

Download a rating table to a CSV.

TreatAsExponential

Treat as exponential

ModelDeploymentStatus

Deployment statuses for model deployments.

DownloadReasonCodes

Function to download and save reason codes rows as csv file

ApplySchema

Apply a schema to DataRobot objects (lists, frames)

AutopilotMode

Autopilot modes

DeleteModel

Delete a specified DataRobot model

ListModels

Retrieve all available model information for a DataRobot project

DeleteModelJob

Delete a model job from the modeling queue

GetAllModels

Retrieve all available model information for a DataRobot project

GetAllLiftCharts

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

ListPredictionDatasets

Retrieve all prediction datasets associated with a project

ProjectFromAsyncUrl

Retrieve a project from the project-creation URL

ReformatMetrics

replace NULL in $metrics list elements with NA

PredictionDatasetFromAsyncUrl

Retrieve prediction dataset info from the dataset creation URL

RequestApproximation

Request an approximation of a model using DataRobot Prime

RequestPredictions

Request predictions for model from newdata

SetupProjectFromOracle

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

RequestPredictionsForDataset

Request predictions against a previously uploaded dataset

RequestReasonCodesInitialization

Request reason codes initialization for specified model

PrimeLanguage

Prime Language

RequestModelDeployment

Request a model deployment.

RequestSampleSizeUpdate

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

GetBlenderModel

Retrieve the details of a specified blender model

RequestNewDatetimeModel

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

SetTarget

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

SetupProject

Function to set up a new DataRobot project

UploadPredictionDataset

Function to upload new data to a DataRobot project for predictions

RequestTrainingPredictions

Request training predictions for a specific model.

UnpauseQueue

Re-start the DataRobot modeling queue

GetConfusionChart

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

SetupProjectFromPostgreSQL

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

UploadTransferrableModel

Import a previously exported model for predictions.

GetPredictions

Retrieve model predictions from predictJobId

GetModelDeploymentServiceStatistics

Retrieve a health overview of a model deployment.

GetModelDeploymentActionLog

Retrieve an action log for a model deployment.

GetDatetimeModelFromJobId

Retrieve a new or updated datetime model defined by modelJobId

ValidateProject

Get a projectId from a project object.

ValidateModel

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

ValidateParameterIn

Ensure a parameter is valid

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.

plot.listOfModels

Plot method for DataRobot S3 objects of class listOfModels

GetFrozenModel

Retrieve the details of a specified frozen model

GetFrozenModelFromJobId

Retrieve a frozen model defined by modelJobId

GetModelFromJobId

Retrieve a new or updated model defined by modelJobId

GetBlenderModelFromJobId

Retrieve a new or updated blender model defined by modelJobId

GetModelJob

Request information about a single model job

ViewWebModel

Retrieve a DataRobot web page that displays detailed model information

WaitForJobToComplete

Wait for specified job to complete

summary.dataRobotModel

DataRobot S3 object methods for R's generic summary function

GetPrimeEligibility

Check if model can be approximated with DataRobot Prime

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.

GetReasonCodesMetadataFromJobId

Retrieve the reason codes metadata for a model using jobId

GetReasonCodesRows

Retrieve all reason codes rows

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.

GetTrainingPredictionsFromJobId

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

GetTransferrableModel

Retrieve imported model info using import id

UpdateTransferrableModel

Update the display name or note for an imported model.

UploadData

Upload a data source.

as.data.frame

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

ListRatingTableModels

Retrieve information about all DataRobot models with a rating table.

ListRatingTables

Retrieve information about all rating tables.

ListReasonCodesMetadata

Retrieve metadata for reason codes in specified project

ListTrainingPredictions

Retrieve information about all training prediction datasets in a project.

RequestNewModel

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

RequestNewRatingTableModel

Create a new model from a rating table.

cvMethods

CV methods

datarobot-package

datarobot: 'DataRobot' Predictive Modeling API

GetModelParameters

Retrieve model parameters

GetModelingFeaturelist

Retrieve a specific modeling featurelist from a DataRobot project

summary.dataRobotModelDeploymentsList

Summarize model deployments

GetRatingTableModelFromJobId

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

ScaleoutModelingMode

Scaleout modeling modes

GetReasonCodesInitialization

Retrieve the reason codes initialization for a model.

ScoreBacktests

Compute the scores for all available backtests.

Stringify

Convert a function into a single string for DataRobot

GetRulesets

List the rulesets approximating a model generated by DataRobot Prime

GetServerDataInRows

Handle server side pagination.

GetValidMetrics

Retrieve the valid fitting metrics for a specified project and target

TargetType

Target Type modes

GetWordCloud

Retrieve word cloud data for a model.

RequestFrozenDatetimeModel

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

RequestFrozenModel

Train a new frozen model with parameters from specified model

SetupProjectFromHDFS

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

SetupProjectFromMySQL

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

UpdateModelDeployment

Update a model deployment.

UpdateProject

Update parameters for an existing project

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.