RDocumentation
Moon
Learn R
Search all packages and functions
⚠️
There's a newer version (2.18.6) of this package.
Take me there.
datarobot (version 2.17.0)
'DataRobot' Predictive Modeling API
Description
For working with the 'DataRobot' predictive modeling platform's API
.
Copy Link
Copy
Link to current version
Version
Version
2.18.6
2.18.5
2.18.4
2.18.2
2.18.1
2.18.0
2.17.1
2.17.0
2.16.0
2.15.0
2.14.2
2.14.1
2.14.0
2.13.0
2.12.1
2.12.0
2.11.0
2.10.0
2.9.0
2.8.0
2.7.1
2.6.0
2.4.0
2.3.1
2.2.32
Down Chevron
Install
install.packages('datarobot')
Monthly Downloads
883
Version
2.17.0
License
MIT + file LICENSE
Maintainer
David Chudzicki
Last Published
February 22nd, 2020
Functions in datarobot (2.17.0)
Search functions
CheckUrl
Make sure the path is a reasonable URL
CleanServerData
Reformat paginated data returned from the server.
CreateComplianceDocumentation
Create compliance documentation from a model.
DataPathFromDataArg
Get the data path.
CreateDataSource
Create a data source.
DataSubset
Data subset for training predictions
DeletePredictionExplanationsInitialization
Delete the prediction explanations initialization for a model.
DeleteComplianceDocTemplate
Deletes a compliance doc template.
DeleteCalendar
Delete a calendar
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).
DownloadTransferableModel
Download an transferable model file for use in an on-premise DataRobot standalone prediction environment.
DeletePredictionExplanations
Function to delete prediction explanations
GetBlueprint
Retrieve a blueprint
BlendMethods
Blend methods
GetBlueprintChart
Retrieve a blueprint chart
GetFeatureAssociationMatrixDetails
Get a sample of the actual values used to measure the association between a pair of features.
GetFeatureAssociationMatrix
Get pairwise feature association statistics for a project's informative features
GetDataStoreTables
Get all tables associated with a data store.
GetDataStoreSchemas
Get the schemas associated with a data store.
GetModelFromJobId
Retrieve a new or updated model defined by modelJobId
BlueprintChartToGraphviz
Convert a blueprint chart into graphviz DOT format
GetModelJob
Request information about a single model job
CreateDatetimePartitionSpecification
Create a list describing datetime partition parameters
CreateDataStore
Create a data store.
CreateStratifiedPartition
Create a stratified sampling-based S3 object of class partition for the SetTarget function
GetPredictJobs
Function to list all prediction jobs in a project
GetPredictionExplanationsInitializationFromJobId
Retrieve the prediction explanations initialization for a model using jobId
GetPredictionDataset
Retrieve data on a prediction dataset
GetRocCurve
Retrieve ROC curve data for a model for a particular data partition (see DataPartition)
GetPredictionExplanationsMetadata
Retrieve metadata for specified prediction explanations
CreateUserPartition
Create a class partition object for use in the SetTarget function representing a user-defined partition.
DeleteJob
Cancel a running job
DeleteModel
Delete a specified DataRobot model
DifferencingMethod
Differencing method
DownloadComplianceDocTemplate
Download a compliance doc template (in JSON format).
GetRulesets
List the rulesets approximating a model generated by DataRobot Prime
DownloadRatingTable
Download a rating table to a CSV.
DownloadPrimeCode
Download the code of DataRobot Prime model and save it to a file.
GetBlenderModel
Retrieve the details of a specified blender model
JobType
Job type
GetTrainingPredictionDataFrame
Simplify the training prediction rows into a tidy format dataframe.
GetTrainingPredictions
Retrieve training predictions on a specified data set.
ListBlueprints
Retrieve the list of available blueprints for a project
ListLiftCharts
Retrieve lift chart data for a model for all available data partitions (see DataPartition)
GetBlenderModelFromJobId
Retrieve a new or updated blender model defined by modelJobId
GetDatetimeModel
Retrieve the details of a specified datetime model.
ConnectToDataRobot
Establish a connection to the DataRobot modeling engine
ConstructDurationString
Construct a valid string representing a duration in accordance with ISO8601
CreateDeployment
Create a deployment.
CreateDerivedFeatures
Derived Features
CreateRandomPartition
Create a random sampling-based S3 object of class partition for the SetTarget function
ListModelFeatures
Returns the list of features (i.e., variables) on which a specified model is based
ListModelRecommendations
Retrieve information about model recommendation made by DataRobot for your project.
MakeDataRobotRequest
Make a HTTP request
ListModelJobs
Retrieve status of Autopilot modeling jobs that are not complete
ModelReplacementReason
Model replacement reason
CreateRatingTable
Creates and validates a new rating table from an uploaded CSV.
GetDatetimeModelFromJobId
Retrieve a new or updated datetime model defined by modelJobId
DeleteModelJob
Delete a model job from the modeling queue
DeleteModelingFeaturelist
Delete a modeling featurelist
ProjectFromAsyncUrl
Retrieve a project from the project-creation URL
PrimeLanguage
Prime Language
GetFeatureImpactForJobId
Retrieve completed Feature Impact results given a job ID
GetFeatureImpactForModel
Retrieve completed Feature Impact results given a model
DeletePredictJob
Function to delete one predict job from the DataRobot queue
GetMissingValuesReport
Get a report on missing values for the model.
GetLiftChart
Retrieve lift chart data for a model for a data partition (see DataPartition)
DownloadScoringCode
Download scoring code JAR
DownloadSeriesAccuracy
Download the series accuracy for a model, computing it if not already computed.
ReplaceDeployedModel
Replace a model in a deployment with another model.
DeletePredictionDataset
Delete a specified prediction dataset
GetModelRecommendation
Retrieve a model recommendation from DataRobot for your project.
GetModelParameters
Retrieve model parameters
RequestApproximation
Request an approximation of a model using DataRobot Prime
SharingRole
Sharing role
RequestSeriesAccuracy
Compute the series accuracy for a model.
GetBlueprintDocumentation
Get documentation for tasks used in the blueprint
SetupProjectFromDataSource
Create a project from a data source.
RequestTrainingPredictions
Request training predictions for a specific model.
GetCalendar
Retrieve a calendar
Share
Share a shareable object with a particular user.
UpdateComplianceDocTemplate
Update the name or sections of an existing doc template.
GetDeployment
Get information on a particular deployment.
GetFeatureInfo
Details about a feature
GetDatetimePartition
Retrieve the DatetimePartitioning from a project
CreateCalendar
Create a calendar from an uploaded CSV.
CrossValidateModel
Run cross validation on a model.
CreateBacktestSpecification
Create a list describing backtest parameters
AddEureqaSolution
Add a Eureqa solution to the list of models for the project.
ApplySchema
Apply a schema to DataRobot objects (lists, frames)
SetupProjectFromHDFS
Function to set up a new DataRobot project using datasource on a WebHDFS server (deprecated)
GetPredictionExplanationsMetadataFromJobId
Retrieve the prediction explanations metadata for a model using jobId
GetPredictionExplanationsRows
Retrieve all prediction explanations rows
GetRatingTableModelFromJobId
Retrieve a new or updated rating table model defined by a job ID.
summary.listOfDataRobotTuningParameters
Summarize the list of tuning parameters available for a model.
UpdateCalendar
Update a calendar
GetRecommendedModel
Retrieve the model object that DataRobot recommends for your project.
ListComplianceDocTemplates
Retrieve information about all compliance doc templates.
GetTrainingPredictionsFromJobId
Retrieve the training predictions for a model using a job id.
ListDataStores
Returns a dataframe with information on available data stores.
GetTrainingPredictionsForModel
Get training predictions for a particular model.
ListCalendars
List all available calendars.
GetFeaturelist
Retrieve a specific featurelist from a DataRobot project
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.
UploadPredictionDatasetFromDataSource
Upload a prediction dataset from a data source.
UpdateDataSource
Update a data store.
DeleteDataStore
Delete a data store.
DeleteTransferableModel
Delete this imported model.
DataPartition
Data Partition methods
DeleteDataSource
Delete a data store.
DeleteProject
Delete a specified element from the DataRobot project list
FeatureFromAsyncUrl
Retrieve a feature from the creation URL
GenerateDatetimePartition
Preview the full partitioning determined by a DatetimePartitioningSpecification
ListDeployments
List all current model deployments.
BatchFeaturesTypeTransform
Create new features by transforming the type of an existing ones.
AutopilotMode
Autopilot modes
CreateFeaturelist
Create a new featurelist in a DataRobot project
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
CreateGroupPartition
Create a group-based S3 object of class partition for the SetTarget function
CreatePrimeCode
Create and validate the downloadable code for the ruleset associated with this model
UpdateDataStore
Update a data store.
UploadTransferableModel
Import a previously exported model for predictions.
GetCalendarFromProject
Retrieve the calendar for a particular project.
datarobot-package
datarobot: 'DataRobot' Predictive Modeling API
plot.listOfModels
Plot method for DataRobot S3 objects of class listOfModels
GetDriver
Returns information about a particular driver.
GetDeploymentDriftTrackingSettings
Get drift tracking settings for a deployment.
DeleteDeployment
Delete a deployment.
GetFeatureHistogram
Retrieve histogram plot data for a specific feature
GetComplianceDocTemplate
Get a compliance doc template.
GetFeatureImpact
Get the feature impact for a model, requesting the feature impact if it is not already available.
ListModelingFeaturelists
Retrieve all modeling featurelists associated with a project
DeleteFeaturelist
Delete a featurelist
DownloadComplianceDocumentation
Download compliance documentation (in DOCX format).
DownloadTimeSeriesFeatureDerivationLog
Download the time series feature derivation log as a text file.
ListModels
Retrieve all available model information for a DataRobot project
DownloadPredictionExplanations
Function to download and save prediction explanations rows as csv file
DownloadTrainingPredictions
Download training predictions on a specified data set.
GetModelBlueprintChart
Retrieve a model blueprint chart
GetModel
Retrieve the details of a specified model
GetConfusionChart
Retrieve a model's confusion chart for a specified source.
GetPredictionExplanations
Get prediction explanations
GetModelingFeaturelist
Retrieve a specific modeling featurelist from a DataRobot project
GetMultiSeriesProperties
Retrieve time series properties for a potential multiseries datetime partition column
GetProjectStatus
Request Autopilot status for a specified DataRobot project
GetPredictionExplanationsInitialization
Retrieve the prediction explanations initialization for a model.
GetPredictions
Retrieve model predictions
ListTrainingPredictions
Retrieve information about all training prediction datasets in a project.
GetPredictionExplanationsRowsAsDataFrame
Retrieve all prediction explanations rows and return them as a data frame
GetPrimeEligibility
Check if model can be approximated with DataRobot Prime
ListTransferableModels
Retrieve information about all imported models This function returns a data.frame that describes all imported models
GetRatingTable
Retrieve a single rating table.
GetPrimeFile
Retrieve a specific Prime file from a DataRobot project
GetTimeSeriesFeatureDerivationLog
Retrieve the time series feature derivation log content
GetServerDataInRows
Handle server side pagination.
ListDataSources
Returns a dataframe with information on available data sources.
GetWordCloud
Retrieve word cloud data for a model.
ListPrimeFiles
List all downloadable code files from DataRobot Prime for the project
GetValidMetrics
Retrieve the valid fitting metrics for a specified project and target
ListPrimeModels
Retrieve information about all DataRobot Prime models for a DataRobot project
ListConfusionCharts
Returns all available confusion charts for the model.
GetCrossValidationScores
Get cross validation scores
GetRatingTableFromJobId
Get a rating table from the rating table job metadata.
GetFrozenModel
Retrieve the details of a specified frozen model
GetDataStore
Returns information about a particular data store.
GetJob
Request information about a job
GetPredictJob
Request information about a predict job
GetGeneralizedInsight
An internal function to help fetch insights.
GetFrozenModelFromJobId
Retrieve a frozen model defined by modelJobId
GetDataSource
Returns information about a particular data source.
GetParetoFront
Pareto Front data for a Eureqa model
GetPrimeFileFromJobId
Retrieve a specific Prime file from a DataRobot project for corresponding jobId
GetPrimeModel
Retrieve information about specified DataRobot Prime model.
GetProject
Retrieve details about a specified DataRobot modeling project
GetPrimeModelFromJobId
Retrieve information about specified DataRobot Prime model using corresponding jobId.
ListProjects
Retrieve a list of all DataRobot projects
JobStatus
Job statuses
GetRatingTableModel
Retrieve information about specified model with a rating table.
GetSeriesAccuracyForModel
Get the series accuracy associated with a particular model.
GetSeriesAccuracy
Get the computed series accuracy for a model, computing it if not already computed.
IsParameterIn
Check if a parameter is in a list of possibilities.
ScaleoutModelingMode
Scaleout modeling modes
GetTransferableModel
Retrieve imported model info using import id
PauseQueue
Pause the DataRobot modeling queue
PeriodicityMaxTimeStep
Periodicity max time step
ListDrivers
Returns a dataframe with information on available drivers.
RequestBlender
Submit a job for creating blender model. Upon success, the new job will be added to the end of the queue.
ListRatingTableModels
Retrieve information about all DataRobot models with a rating table.
RequestCrossSeriesDetection
Format a cross series with group by columns.
RequestNewDatetimeModel
Adds a new datetime model of the type specified by the blueprint to a DataRobot project
TargetLeakageType
Target leakage report values
RequestPredictions
Request predictions from a model against a previously uploaded dataset
RequestPredictionExplanationsInitialization
Request prediction explanations initialization for specified model
ToggleStarForModel
Star a model if it is unstarred, otherwise unstar the model.
StartTuningSession
Create a function to initiate hyperparameter tuning for a particular model.
PeriodicityTimeUnits
Periodicity time units
Stringify
Convert a function into a single string for DataRobot
ScoreBacktests
Compute the scores for all available backtests.
UpdateDeploymentDriftTrackingSettings
Update drift tracking settings for a deployment.
PostgreSQLdrivers
PostgreSQL drivers
ReformatMetrics
replace NULL in $metrics list elements with NA
UploadPredictionDataset
Function to upload new data to a DataRobot project for predictions
GetTuningParameters
Retrieve data on tuning parameters for a particular model.
ValidateMultiSeriesProperties
Validate that the multiseries properties indicate a successful multiseries setup.
UpdateFeaturelist
Update a featurelist
ValidateParameterIn
Ensure a parameter is valid
ValidateProject
Get a projectId from a project object.
TreatAsExponential
Treat as exponential
ListFeatureInfo
Details about all features for this project
RequestPrimeModel
Request training for a DataRobot Prime model using a specified ruleset
IsBlenderEligible
Check whether individual models can be blended together
ListPredictionServers
List all available prediction servers.
IsId
Checks if an id is a valid DataRobot ID (24 character string)
RenameRatingTable
Renames a rating table to a different name.
ListJobs
Retrieve information about jobs
ListFeaturelists
Retrieve all featurelists associated with a project
ListPredictionDatasets
Retrieve all prediction datasets associated with a project
ViewWebModel
Retrieve a DataRobot web page that displays detailed model information
ListPredictionExplanationsMetadata
Retrieve metadata for prediction explanations in specified project
ViewWebProject
Retrieve a DataRobot web page that displays detailed project information
RequestNewModel
Adds a new model of type specified by blueprint to a DataRobot project
SetupProject
Function to set up a new DataRobot project
UploadData
Upload a data source.
ListSharingAccess
List information about which users have what kinds of access to a shared object.
ListRatingTables
Retrieve information about all rating tables.
ListStarredModels
List all the starred models in a project.
cvMethods
CV methods
ListPredictions
Fetch all computed predictions for a project.
UpdateAccess
Update access to a particular object.
SetTarget
Set the target variable (and by default, start the DataRobot Autopilot)
TargetType
Target Type modes
ValidatePartition
Checks if a partition is valid.
UnstarModel
Unstar a model.
ProjectStage
Project stage
ListRocCurves
Retrieve ROC curve data for a model for all available data partitions (see DataPartition)
RequestNewRatingTableModel
Create a new model from a rating table.
RecommendedModelType
Recommended model type values
ValidateCalendar
Get a calendar id from a calendar object.
summary.dataRobotModel
DataRobot S3 object methods for R's generic summary function
predict.dataRobotModel
Retrieve model predictions using R's default S3
predict
method.
Predict
Retrieve model predictions
RequestFrozenModel
Train a new frozen model with parameters from specified model
TestDataStore
Test the database connection to the data store.
RunInteractiveTuning
Run an interactive model tuning session.
RequestMultiSeriesDetection
Format a multiseries.
StarModel
Star a model.
RequestPredictionExplanations
Request prediction explanations computation for a specified model and dataset.
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.
PredictionDatasetFromAsyncUrl
Retrieve prediction dataset info from the dataset creation URL
StartProject
Start a project, set the target, and run autopilot.
RequestFeatureImpact
Request Feature Impact to be computed.
TimeUnits
Time units
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.
UpdateTransferableModel
Update the display name or note for an imported model.
ValidateReplaceDeployedModel
Validate a potential deployment model replacement.
UploadComplianceDocTemplate
Upload a compliance doc template.
WaitForAutopilot
This function periodically checks whether Autopilot is finished and returns only after it is.
RequestFrozenDatetimeModel
Train a new frozen datetime model with parameters from the specified model
RequestSampleSizeUpdate
Refits an existing model to a different fraction of the training dataset
VariableTransformTypes
Types of variable transformations
SetPredictionThreshold
Set a custom prediction threshold for binary classification models.
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.
UnpauseQueue
Re-start the DataRobot modeling queue
UpdateProject
Update parameters for an existing project
TryingToSubmitNull
Checks to see if we are trying to submit `NULL` as a value.
SeriesAggregationType
Series aggregation type
UpdateModelingFeaturelist
Update a modeling featurelist
WaitForJobToComplete
Wait for specified job to complete
ValidateModel
Validate that model belongs to class 'dataRobotModel' and includes projectId and modelId.
as.data.frame
DataRobot S3 object methods for R's generic as.data.frame function