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

datarobot (version 2.14.2)

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

License

MIT + file LICENSE

Maintainer

David Chudzicki

Last Published

August 28th, 2019

Functions in datarobot (2.14.2)

ConnectToDataRobot

Establish a connection to the DataRobot modeling engine

CreateRandomPartition

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

DeleteDataStore

Delete a data store.

CreateBacktestSpecification

Create a list describing backtest parameters

CreateComplianceDocumentation

Create compliance documentation from a model.

CreateRatingTable

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

DeleteFeaturelist

Delete a featurelist

DeleteProject

Delete a specified element from the DataRobot project list

DeleteModelingFeaturelist

Delete a modeling featurelist

DifferencingMethod

Differencing method

DeleteReasonCodes

Function to delete reason codes (deprecated)

GetModelFromJobId

Retrieve a new or updated model defined by modelJobId

FeatureFromAsyncUrl

Retrieve a feature from the creation URL

GetDataStore

Returns information about a particular data store.

GetGeneralizedInsight

An internal function to help fetch insights.

DownloadComplianceDocTemplate

Download a compliance doc template (in JSON format).

GetDataStoreSchemas

Get the schemas associated with a data store.

GetJob

Request information about a job

GenerateDatetimePartition

Preview the full partitioning determined by a DatetimePartitioningSpecification

GetModelJob

Request information about a single model job

DownloadComplianceDocumentation

Download compliance documentation (in DOCX format).

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

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

BlendMethods

Blend methods

CreatePrimeCode

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

DataSubset

Data subset for training predictions

DownloadScoringCode

Download scoring code JAR

GetPredictionExplanationsMetadataFromJobId

Retrieve the prediction explanations metadata for a model using jobId

AddEureqaSolution

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

CrossValidateModel

Run cross validation on a model.

DownloadTimeSeriesFeatureDerivationLog

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

CleanServerData

Reformat paginated data returned from the server.

DeletePredictJob

Function to delete one predict job from the DataRobot queue

BlueprintChartToGraphviz

Convert a blueprint chart into graphviz DOT format

DataPartition

Data Partition methods

DeletePredictionDataset

Delete a specified prediction dataset

DownloadTrainingPredictions

Download training predictions on a specified data set.

GetBlueprintChart

Retrieve a blueprint chart

GetBlueprintDocumentation

Get documentation for tasks used in the blueprint

GetDriver

Returns information about a particular driver.

GetTrainingPredictionDataFrame

Simplify the training prediction rows into a tidy format dataframe.

GetPrimeFile

Retrieve a specific Prime file from a DataRobot project

GetModelCapabilities

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

GetModelBlueprintDocumentation

Get documentation for tasks used in the model blueprint

GetDatetimePartition

Retrieve the DatetimePartitioning from a project

GetTimeSeriesFeatureDerivationLog

Retrieve the time series feature derivation log content

GetPrimeEligibility

Check if model can be approximated with DataRobot Prime

GetTrainingPredictions

Retrieve training predictions on a specified data set.

GetCrossValidationScores

Get cross validation scores

DownloadTransferrableModel

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

DownloadPredictionExplanations

Function to download and save prediction explanations rows as csv file

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

ApplySchema

Apply a schema to DataRobot objects (lists, frames)

CreateGroupPartition

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

CreateFeaturelist

Create a new featurelist in a DataRobot project

CreateUserPartition

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

CreateStratifiedPartition

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

GetDataStoreTables

Get all tables associated with a data store.

GetTrainingPredictionsForModel

Get training predictions for a particular model.

GetDatetimeModelFromJobId

Retrieve a new or updated datetime model defined by modelJobId

GetDatetimeModelObject

Get a datetime model object (deprecated).

GetDataSource

Returns information about a particular data source.

GetDatetimeModel

Retrieve the details of a specified datetime model.

GetRatingTableFromJobId

Get a rating table from the rating table job metadata.

GetRatingTableModel

Retrieve information about specified model with a rating table.

GetPredictionExplanationsRows

Retrieve all prediction explanations rows

GetRulesets

List the rulesets approximating a model generated by DataRobot Prime

ListDataSources

Returns a dataframe with information on available data sources.

DeleteJob

Cancel a running job

ListDataStores

Returns a dataframe with information on available data stores.

ListRocCurves

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

PeriodicityTimeUnits

Periodicity time units

RequestFeatureImpact

Request Feature Impact to be computed.

ListPredictionExplanationsMetadata

Retrieve metadata for prediction explanations in specified project

ListReasonCodesMetadata

Retrieve metadata for reason codes in specified project (deprecated)

RequestBlender

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

SetPredictionThreshold

Set a custom prediction threshold for binary classification models.

ListPredictionDatasets

Retrieve all prediction datasets associated with a project

PeriodicityMaxTimeStep

Periodicity max time step

GetFeatureInfo

Details about a feature

GetLiftChart

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

GetPredictJob

Request information about a predict job

GetParetoFront

Pareto Front data for a Eureqa model

GetMissingValuesReport

Get a report on missing values for the model.

GetPredictionExplanationsRowsAsDataFrame

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

GetPrimeModelFromJobId

Retrieve information about specified DataRobot Prime model using corresponding jobId.

GetPredictions

Retrieve model predictions

GetFeaturelist

Retrieve a specific featurelist from a DataRobot project

GetModelParameters

Retrieve model parameters

GetModelRecommendation

Retrieve a model recommendedation from DataRobot for your project.

GetPredictionExplanationsInitializationFromJobId

Retrieve the prediction explanations initialization for a model using jobId

GetProject

Retrieve details about a specified DataRobot modeling project

GetRatingTableModelFromJobId

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

GetRecommendedModel

Retrieve the model object that DataRobot recommends for your project.

GetRocCurve

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

GetReasonCodesInitialization

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

GetPredictionExplanationsMetadata

Retrieve metadata for specified prediction explanations

GetWordCloud

Retrieve word cloud data for a model.

GetReasonCodesMetadataFromJobId

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

GetReasonCodesRows

Retrieve all reason codes rows (deprecated)

IsBlenderEligible

Check whether individual models can be blended together

ListConfusionCharts

Returns all available confusion charts for the model.

ListComplianceDocTemplates

Retrieve information about all compliance doc templates.

ListSharingAccess

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

CreateDataSource

Create a data source.

DeleteReasonCodesInitialization

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

DeleteModel

Delete a specified DataRobot model

DeleteTransferrableModel

Delete this imported model.

GetBlenderModelFromJobId

Retrieve a new or updated blender model defined by modelJobId

IsParameterIn

Check if a parameter is in a list of possibilities.

SetTarget

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

GetFeatureImpactForJobId

Retrieve completed Feature Impact results given a job ID

List all the starred models in a project.

GetFeatureImpactForModel

Retrieve completed Feature Impact results given a model

GetFrozenModel

Retrieve the details of a specified frozen model

Share a sharable object with a particular user.

SharingRole

Sharing role

UnpauseQueue

Re-start the DataRobot modeling queue

UpdateDataSource

Update a data store.

UpdateComplianceDocTemplate

Update the name or sections of an existing doc template.

TryingToSubmitNull

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

DeletePredictionExplanations

Function to delete prediction explanations

ListPredictions

Fetch all computed predictions for a project.

ListFeaturelists

Retrieve all featurelists associated with a project

ListJobs

Retrieve information about jobs

GetServerDataInRows

Handle server side pagination.

UploadPredictionDatasetFromDataSource

Upload a prediction dataset from a data source.

ListPrimeFiles

List all downloadable code files from DataRobot Prime for the project

GetFrozenModelFromJobId

Retrieve a frozen model defined by modelJobId

GetPredictJobs

Function to list all prediction jobs in a project

GetPredictionDataset

Retrieve data on a prediction dataset

GetProjectStatus

Request Autopilot status for a specified DataRobot project

ListModelingFeaturelists

Retrieve all modeling featurelists associated with a project

ListBlueprints

Retrieve the list of available blueprints for a project

JobType

Job type

ListModels

Retrieve all available model information for a DataRobot project

ListTrainingPredictions

Retrieve information about all training prediction datasets in a project.

GetRatingTable

Retrieve a single rating table.

RenameRatingTable

Renames a rating table to a different name.

DownloadPrimeCode

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

DeletePredictionExplanationsInitialization

Delete the prediction explanations initialization for a model.

GetTuningParameters

Retrieve data on tuning parameters for a particular model.

DownloadRatingTable

Download a rating table to a CSV.

ListModelJobs

Retrieve status of Autopilot modeling jobs that are not complete

ProjectFromAsyncUrl

Retrieve a project from the project-creation URL

RecommendedModelType

Recommended model type values

ListRatingTableModels

Retrieve information about all DataRobot models with a rating table.

ListModelRecommendations

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

ListRatingTables

Retrieve information about all rating tables.

GetValidMetrics

Retrieve the valid fitting metrics for a specified project and target

ProjectStage

Project stage

UploadTransferrableModel

Import a previously exported model for predictions.

ListTransferrableModels

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

Predict

Retrieve model predictions

RunInteractiveTuning

Run an interactive model tuning session.

RequestFrozenDatetimeModel

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

StarModel

Star a model.

RequestNewModel

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

ScaleoutModelingMode

Scaleout modeling modes

RequestNewRatingTableModel

Create a new model from a rating table.

ReformatMetrics

replace NULL in $metrics list elements with NA

WaitForJobToComplete

Wait for specified job to complete

as.data.frame

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

RequestFrozenModel

Train a new frozen model with parameters from specified model

GetFeatureImpact

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

GetBlenderModel

Retrieve the details of a specified blender model

GetAllReasonCodesRowsAsDataFrame

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

GetModelBlueprintChart

Retrieve a model blueprint chart

GetConfusionChart

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

GetComplianceDocTemplate

Get a compliance doc template.

GetModel

Retrieve the details of a specified model

GetModelingFeaturelist

Retrieve a specific modeling featurelist from a DataRobot project

GetFeatureHistogram

Retrieve histogram plot data for a specific feature

PredictionDatasetFromAsyncUrl

Retrieve prediction dataset info from the dataset creation URL

RequestPrimeModel

Request training for a DataRobot Prime model using a specified ruleset

UploadData

Upload a data source.

SeriesAggregationType

Series aggregation type

ScoreBacktests

Compute the scores for all available backtests.

RequestReasonCodes

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

UploadPredictionDataset

Function to upload new data to a DataRobot project for predictions

GetPredictionExplanationsInitialization

Retrieve the prediction explanations initialization for a model.

GetPrimeFileFromJobId

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

GetMultiSeriesProperties

Retrieve time series properties for a potential multiseries datetime partition column

GetPredictionExplanations

Get prediction explanations

PrimeLanguage

Prime Language

RequestMultiSeriesDetection

Format a multiseries.

GetReasonCodesInitializationFromJobId

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

GetPrimeModel

Retrieve information about specified DataRobot Prime model.

GetReasonCodesMetadata

Retrieve metadata for specified reason codes (deprecated)

RequestNewDatetimeModel

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

RequestPredictionExplanations

Request prediction explanations computation for a specified model and dataset.

RequestApproximation

Request an approximation of a model using DataRobot Prime

RequestReasonCodesInitialization

Request reason codes initialization for specified model (deprecated)

RequestSampleSizeUpdate

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

SetupProject

Function to set up a new DataRobot project

GetTrainingPredictionsFromJobId

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

GetTransferrableModel

Retrieve imported model info using import id

ListDrivers

Returns a dataframe with information on available drivers.

RequestTrainingPredictions

Request training predictions for a specific model.

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.

RequestPredictionExplanationsInitialization

Request prediction explanations initialization for specified 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.

TestDataStore

Test the database connection to the data store.

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

TargetLeakageType

Target leakage report values

Details about all features for this project

UpdateModelingFeaturelist

Update a modeling featurelist

ViewWebProject

Retrieve a DataRobot web page that displays detailed project information

ListLiftCharts

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

WaitForAutopilot

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

ListModelFeatures

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

UpdateProject

Update parameters for an existing project

SetupProjectFromDataSource

Create a project from a data source.

SetupProjectFromOracle

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

SetupProjectFromPostgreSQL

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

summary.listOfDataRobotTuningParameters

Summarize the list of tuning parameters available for a model.

summary.dataRobotModel

DataRobot S3 object methods for R's generic summary function

ListPrimeModels

Retrieve information about all DataRobot Prime models for a DataRobot project

ToggleStarForModel

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

TreatAsExponential

Treat as exponential

ListProjects

Retrieve a list of all DataRobot projects

MakeDataRobotRequest

Make a HTTP request

RequestPredictions

Request predictions against a previously uploaded dataset

PauseQueue

Pause the DataRobot modeling queue

StartProject

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

RequestPredictionsForDataset

Deprecated version of request predictions

UnstarModel

Unstar a model.

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.

Stringify

Convert a function into a single string for DataRobot

StartTuningSession

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

UpdateTransferrableModel

Update the display name or note for an imported model.

UploadComplianceDocTemplate

Upload a compliance doc template.

ValidateModel

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

ValidateParameterIn

Ensure a parameter is valid

cvMethods

CV methods

datarobot-package

datarobot: 'DataRobot' Predictive Modeling API

UpdateAccess

Update access to a particular object.

ValidateProject

Get a projectId from a project object.

ViewWebModel

Retrieve a DataRobot web page that displays detailed model information

plot.listOfModels

Plot method for DataRobot S3 objects of class listOfModels

predict.dataRobotModel

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

ConstructDurationString

Construct a valid string representing a duration in accordance with ISO8601

CreateDerivedFeatures

Derived Features

CreateDatetimePartitionSpecification

Create a list describing datetime partition parameters

DeleteComplianceDocTemplate

Deletes a compliance doc template.

DeleteModelJob

Delete a model job from the modeling queue

DeleteDataSource

Delete a data store.