# 'DataRobot' Predictive Modeling API

## Documentation for package ‘datarobot’ version 2.18.5

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A B C D E F G I J L M P R S T U V W

datarobot-package | datarobot: 'DataRobot' Predictive Modeling API

## -- A --

AddEureqaSolution | Add a Eureqa solution to the list of models for the project.
ApplySchema | Apply a schema to DataRobot objects (lists, frames)
as.data.frame | DataRobot S3 object methods for R's generic as.data.frame function
as.data.frame.listOfBlueprints | DataRobot S3 object methods for R's generic as.data.frame function
as.data.frame.listOfDataRobotPredictionDatasets | DataRobot S3 object methods for R's generic as.data.frame function
as.data.frame.listOfFeaturelists | DataRobot S3 object methods for R's generic as.data.frame function
as.data.frame.listOfModels | DataRobot S3 object methods for R's generic as.data.frame function
as.data.frame.projectSummaryList | DataRobot S3 object methods for R's generic as.data.frame function
as.dataRobotFeatureInfo | Information on a data feature.
as.dataRobotMultiSeriesProperties | Return value for GetMultiSeriesProperties() and others
as.dataRobotProjectShort | Return value for SetupProject() and others
AutopilotMode | Autopilot modes

## -- B --

BatchFeaturesTypeTransform | Create new features by transforming the type of an existing ones.
BlendMethods | Blend methods
BlueprintChartToGraphviz | Convert a blueprint chart into graphviz DOT format

## -- C --

CheckUrl | Make sure the path is a reasonable URL
ClassificationDeploymentAccuracyMetric | Accuracy metrics for classification deployments
CleanServerData | Reformat paginated data returned from the server.
CloneProject | Clone a project
ComputeDatetimeTrendPlots | Compute datetime trend plots for datetime partitioned model.
ConnectToDataRobot | Establish a connection to the DataRobot modeling engine
ConstructDurationString | Construct a valid string representing a duration in accordance with ISO8601
CreateBacktestSpecification | Create a list describing backtest parameters
CreateCalendar | Create a calendar from an uploaded CSV.
CreateComplianceDocumentation | Create compliance documentation from a model.
CreateDataSource | Create a data source.
CreateDataStore | Create a data store.
CreateDatetimePartitionSpecification | Create a list describing datetime partition parameters
CreateDeployment | Create a deployment.
CreateDerivedFeatureAsCategorical | Derived Features
CreateDerivedFeatureAsNumeric | Derived Features
CreateDerivedFeatureAsText | Derived Features
CreateDerivedFeatureIntAsCategorical | Derived Features
CreateDerivedFeatures | Derived Features
CreateFeaturelist | Create a new featurelist in a DataRobot project
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
CreatePrimeCode | Create and validate the downloadable code for the ruleset associated with this model
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.
CreateStratifiedPartition | Create a stratified sampling-based S3 object of class partition for the SetTarget function
CreateUserPartition | Create a class partition object for use in the SetTarget function representing a user-defined partition.
CrossValidateModel | Run cross validation on a model.
cvMethods | CV methods

## -- D --

DataPartition | Data Partition methods
DataPathFromDataArg | Get the data path.
datarobot | datarobot: 'DataRobot' Predictive Modeling API
DataSubset | Data subset for training predictions
DatetimeTrendPlotsResolutions | Datetime trend plots resolutions
DatetimeTrendPlotsStatuses | Datetime trend plots statuses
DeleteAnomalyAssessmentRecord | Delete anomaly assessment record.
DeleteCalendar | Delete a calendar
DeleteComplianceDocTemplate | Deletes a compliance doc template.
DeleteDataSource | Delete a data store.
DeleteDataStore | Delete a data store.
DeleteDeployment | Delete a deployment.
DeleteFeaturelist | Delete a featurelist
DeleteJob | Cancel a running job
DeleteModel | Delete a specified DataRobot model
DeleteModelingFeaturelist | Delete a modeling featurelist
DeleteModelJob | Delete a model job from the modeling queue
DeletePredictionDataset | Delete a specified prediction dataset
DeletePredictionExplanations | Function to delete prediction explanations
DeletePredictionExplanationsInitialization | Delete the prediction explanations initialization for a model.
DeletePredictJob | Function to delete one predict job from the DataRobot queue
DeleteProject | Delete a specified element from the DataRobot project list
DeleteTransferableModel | Delete this imported model.
DeploymentAccuracyMetric | Deployment accuracy metrics
DeploymentServiceHealthMetric | Deployment service health metrics
DifferencingMethod | Differencing method
DownloadComplianceDocTemplate | Download a compliance doc template (in JSON format).
DownloadComplianceDocumentation | Download compliance documentation (in DOCX format).
DownloadPredictionExplanations | Function to download and save prediction explanations rows as csv file
DownloadPrimeCode | Download the code of DataRobot Prime model and save it to a file.
DownloadRatingTable | Download a rating table to a CSV.
DownloadScoringCode | Download scoring code JAR
DownloadSeriesAccuracy | Download the series accuracy for a model, computing it if not already computed.
DownloadTimeSeriesFeatureDerivationLog | Download the time series feature derivation log as a text file.
DownloadTrainingPredictions | Download training predictions on a specified data set.
DownloadTransferableModel | Download an transferable model file for use in an on-premise DataRobot standalone prediction environment.

## -- E --

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

## -- F --

FeatureFromAsyncUrl | Retrieve a feature from the creation URL
formatRFC3339Timestamp | formatRFC3339Timestamp

## -- G --

GenerateDatetimePartition | Preview the full partitioning determined by a DatetimePartitioningSpecification
GetAccuracyOverTimePlot | Retrieve Accuracy over Time plot for a model.
GetAccuracyOverTimePlotPreview | Retrieve Accuracy over Time preview plot for a model.
GetAccuracyOverTimePlotsMetadata | Retrieve Accuracy over Time plots metadata for a model.
GetAnomalyAssessmentExplanations | Retrieve anomaly assessment explanations.
GetAnomalyAssessmentPredictionsPreview | Retrieve anomaly assessment predictions preview.
GetBlenderModel | Retrieve the details of a specified blender model
GetBlenderModelFromJobId | Retrieve a new or updated blender model defined by modelJobId
GetBlueprint | Retrieve a blueprint
GetBlueprintChart | Retrieve a blueprint chart
GetBlueprintDocumentation | Get documentation for tasks used in the blueprint
GetCalendar | Retrieve a calendar
GetCalendarFromProject | Retrieve the calendar for a particular project.
GetComplianceDocTemplate | Get a compliance doc template.
GetConfusionChart | Retrieve a model's confusion chart for a specified source.
GetCrossValidationScores | Get cross validation scores
GetDataSource | Returns information about a particular data source.
GetDataStore | Returns information about a particular data store.
GetDataStoreSchemas | Get the schemas associated with a data store.
GetDataStoreTables | Get all tables associated with a data store.
GetDatetimeModel | Retrieve the details of a specified datetime model.
GetDatetimeModelFromJobId | Retrieve a new or updated datetime model defined by modelJobId
GetDatetimePartition | Retrieve the DatetimePartitioning from a project
GetDeployment | Get information on a particular deployment.
GetDeploymentAccuracy | Retrieve accuracy statistics for a deployment.
GetDeploymentAccuracyOverTime | Retrieves accuracy statistics over time on given metrics for a deployment.
GetDeploymentAssociationId | Deployment Association ID
GetDeploymentDriftTrackingSettings | Get drift tracking settings for a deployment.
GetDeploymentServiceStats | Retrieve service health statistics for a deployment.
GetDeploymentServiceStatsOverTime | Retrieves service health statistics over time on given metrics for a deployment.
GetDriver | Returns information about a particular driver.
GetFeatureAssociationMatrix | Get pairwise feature association statistics for a project's informative features
GetFeatureAssociationMatrixDetails | Get a sample of the actual values used to measure the association between a pair of features.
GetFeatureHistogram | Retrieve histogram plot data for a specific feature
GetFeatureImpact | Get the feature impact for a model, requesting the feature impact if it is not already available.
GetFeatureImpactForJobId | Retrieve completed Feature Impact results given a job ID
GetFeatureImpactForModel | Retrieve completed Feature Impact results given a model
GetFeatureInfo | Details about a feature
GetFeaturelist | Retrieve a specific featurelist from a DataRobot project
GetFrozenModel | Retrieve the details of a specified frozen model
GetFrozenModelFromJobId | Retrieve a frozen model defined by modelJobId
GetGeneralizedInsight | An internal function to help fetch insights.
GetJob | Request information about a job
GetLiftChart | Retrieve lift chart data for a model for a data partition (see DataPartition)
GetMissingValuesReport | Get a report on missing values for the model.
GetModel | Retrieve the details of a specified model
GetModelBlueprintChart | Retrieve a model blueprint chart
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.
GetModelFromJobId | Retrieve a new or updated model defined by modelJobId
GetModelingFeaturelist | Retrieve a specific modeling featurelist from a DataRobot project
GetModelJob | Request information about a single model job
GetModelParameters | Retrieve model parameters
GetModelRecommendation | Retrieve a model recommendation from DataRobot for your project.
GetMultiSeriesProperties | Retrieve time series properties for a potential multiseries datetime partition column
GetParetoFront | Pareto Front data for a Eureqa model
GetPredictionDataset | Retrieve data on a prediction dataset
GetPredictionExplanations | Get prediction explanations
GetPredictionExplanationsInitialization | Retrieve the prediction explanations initialization for a model.
GetPredictionExplanationsInitializationFromJobId | Retrieve the prediction explanations initialization for a model using jobId
GetPredictionExplanationsMetadata | Retrieve metadata for specified prediction explanations
GetPredictionExplanationsMetadataFromJobId | Retrieve the prediction explanations metadata for a model using jobId
GetPredictionExplanationsRows | Retrieve all prediction explanations rows
GetPredictionExplanationsRowsAsDataFrame | Retrieve all prediction explanations rows and return them as a data frame
GetPredictions | Retrieve model predictions
GetPredictJob | Request information about a predict job
GetPredictJobs | Function to list all prediction jobs in a project
GetPrimeEligibility | Check if model can be approximated with DataRobot Prime
GetPrimeFile | Retrieve a specific Prime file from a DataRobot project
GetPrimeFileFromJobId | Retrieve a specific Prime file from a DataRobot project for corresponding jobId
GetPrimeModel | Retrieve information about specified DataRobot Prime model.
GetPrimeModelFromJobId | Retrieve information about specified DataRobot Prime model using corresponding jobId.
GetProject | Retrieve details about a specified DataRobot modeling project
GetProjectStatus | Request Autopilot status for a specified DataRobot project
GetRatingTable | Retrieve a single rating table.
GetRatingTableFromJobId | Get a rating table from the rating table job metadata.
GetRatingTableModel | Retrieve information about specified model with a rating table.
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.
GetResidualsChart | Retrieve residuals chart data for a model for a data partition (see DataPartition).
GetRocCurve | Retrieve ROC curve data for a model for a particular data partition (see DataPartition)
GetRulesets | List the rulesets approximating a model generated by DataRobot Prime
GetSeriesAccuracy | Get the computed series accuracy for a model, computing it if not already computed.
GetSeriesAccuracyForModel | Get the series accuracy associated with a particular model.
GetServerDataInRows | Handle server side pagination.
GetTimeSeriesFeatureDerivationLog | Retrieve the time series feature derivation log content
GetTrainingPredictionDataFrame | Simplify the training prediction rows into a tidy format dataframe.
GetTrainingPredictions | Retrieve training predictions on a specified data set.
GetTrainingPredictionsForModel | Get training predictions for a particular model.
GetTrainingPredictionsFromJobId | Retrieve the training predictions for a model using a job id.
GetTransferableModel | Retrieve imported model info using import id
GetTuningParameters | Retrieve data on tuning parameters for a particular model.
GetValidMetrics | Retrieve the valid fitting metrics for a specified project and target
GetWordCloud | Retrieve word cloud data for a model.

## -- I --

InitializeAnomalyAssessment | Request anomaly assessment insight computation on the specified subset.
IsBlenderEligible | Check whether individual models can be blended together
IsId | Checks if an id is a valid DataRobot ID (24 character string)
IsParameterIn | Check if a parameter is in a list of possibilities.

## -- J --

JobStatus | Job statuses
JobType | Job type

## -- L --

ListAnomalyAssessmentRecords | Retrieve anomaly assessment records.
ListBlueprints | Retrieve the list of available blueprints for a project
ListCalendars | List all available calendars.
ListComplianceDocTemplates | Retrieve information about all compliance doc templates.
ListConfusionCharts | Returns all available confusion charts for the model.
ListDataSources | Returns a dataframe with information on available data sources.
ListDataStores | Returns a dataframe with information on available data stores.
ListDeployments | List all current model deployments.
ListDrivers | Returns a dataframe with information on available drivers.
ListFeatureInfo | Details about all features for this project
ListFeaturelists | Retrieve all featurelists associated with a project
ListJobs | Retrieve information about jobs
ListLiftCharts | Retrieve lift chart data for a model for all available data partitions (see DataPartition)
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
ListModelJobs | Retrieve status of Autopilot modeling jobs that are not complete
ListModelRecommendations | Retrieve information about model recommendation made by DataRobot for your project.
ListModels | Retrieve all available model information for a DataRobot project
ListPredictionDatasets | Retrieve all prediction datasets associated with a project
ListPredictionExplanationsMetadata | Retrieve metadata for prediction explanations in specified project
ListPredictions | Fetch all computed predictions for a project.
ListPredictionServers | List all available prediction servers.
ListPrimeFiles | List all downloadable code files from DataRobot Prime for the project
ListPrimeModels | Retrieve information about all DataRobot Prime models for a DataRobot project
ListProjects | Retrieve a list of all DataRobot projects
ListRatingTableModels | Retrieve information about all DataRobot models with a rating table.
ListRatingTables | Retrieve information about all rating tables.
ListResidualsCharts | Retrieve residuals chart data for a model for all available data partitions (see 'DataPartition'). This chart is only available for regression models that are not time-aware.
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.
ListStarredModels | List all the starred models in a project.
ListTrainingPredictions | Retrieve information about all training prediction datasets in a project.
ListTransferableModels | Retrieve information about all imported models This function returns a data.frame that describes all imported models

## -- M --

MakeDataRobotRequest | Make a HTTP request
ModelCapability | Model capabilities
ModelReplacementReason | Model replacement reason
MulticlassDeploymentAccuracyMetric | Accuracy metrics for multiclass deployments

## -- P --

parseRFC3339Timestamp | parseRFC3339Timestamp
PauseQueue | Pause the DataRobot modeling queue
PeriodicityMaxTimeStep | Periodicity max time step
PeriodicityTimeUnits | Periodicity time units
plot.listOfModels | Plot method for DataRobot S3 objects of class listOfModels
PostgreSQLdrivers | PostgreSQL drivers
Predict | Retrieve model predictions
predict.dataRobotModel | Retrieve model predictions using R's default S3 'predict' method.
PredictionDatasetFromAsyncUrl | Retrieve prediction dataset info from the dataset creation URL
PrimeLanguage | Prime Language
ProjectFromJobResponse | Retrieve a project from the job response, which has a project-creation URL
ProjectStage | Project stage

## -- R --

RecommendedModelType | Recommended model type values
ReformatMetrics | replace NULL in $metrics list elements with NA
RegressionDeploymentAccuracyMetric | Accuracy metrics for regression deployments
RenameRatingTable | Renames a rating table to a different name.
reorderColumns | Reorder the columns in a data.frame
ReplaceDeployedModel | Replace a model in a deployment with another model.
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.
RequestCrossSeriesDetection | Format a cross series with group by columns.
RequestFeatureImpact | Request Feature Impact to be computed.
RequestFrozenDatetimeModel | Train a new frozen datetime model with parameters from the specified model
RequestFrozenModel | Train a new frozen model with parameters from specified model
RequestMultiSeriesDetection | Format a multiseries.
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
RequestNewRatingTableModel | Create a new model from a rating table.
RequestPredictionExplanations | Request prediction explanations computation for a specified model and dataset.
RequestPredictionExplanationsInitialization | Request prediction explanations initialization for specified model
RequestPredictions | Request predictions from a model against a previously uploaded dataset
RequestPrimeModel | Request training for a DataRobot Prime model using a specified ruleset
RequestSampleSizeUpdate | Refits an existing model to a different fraction of the training dataset
RequestSeriesAccuracy | Compute the series accuracy for a model.
RequestTrainingPredictions | Request training predictions for a specific model.
RequestTransferableModel | Request creation of a transferable model
RFC3339DateTimeFormat | RFC 3339 datetime format
RunInteractiveTuning | Run an interactive model tuning session.

## -- S --

ScoreBacktests | Compute the scores for all available backtests.
SegmentAnalysisAttribute | Segment analysis attributes
SeriesAggregationType | Series aggregation type
SetPredictionThreshold | Set a custom prediction threshold for binary classification models.
SetTarget | Set the target variable (and by default, start the DataRobot Autopilot)
SetupProject | Function to set up a new DataRobot project
SetupProjectFromDataSource | Create a project from a data source.
SetupProjectFromHDFS | Function to set up a new DataRobot project using datasource on a WebHDFS server (deprecated)
Share | Share a shareable object with a particular user.
SharingRole | Sharing role
SourceType | Source types
StarModel | Star a 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 - modeling jobs in queue would not be affected but new jobs would not be added to queue by halted autopilot.
StartProject | Start a project, set the target, and run autopilot.
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.
StartTuningSession | Create a function to initiate hyperparameter tuning for a particular model.
Stringify | Convert a function into a single string for DataRobot
SubmitActuals | Submit actuals for processing.
summary.dataRobotModel | DataRobot S3 object methods for R's generic summary function
summary.dataRobotProject | DataRobot S3 object methods for R's generic summary function
summary.listOfBlueprints | DataRobot S3 object methods for R's generic summary function
summary.listOfDataRobotTuningParameters | Summarize the list of tuning parameters available for a model.
summary.listOfFeaturelists | DataRobot S3 object methods for R's generic summary function
summary.listOfModels | DataRobot S3 object methods for R's generic summary function
summary.projectSummaryList | DataRobot S3 object methods for R's generic summary function

## -- T --

TargetLeakageType | Target leakage report values
TargetType | Target Type modes
TestDataStore | Test the database connection to the data store.
tidyServiceOverTimeObject | Tidies a ServiceOverTime response object for use in a DF
TimeUnits | Time units
ToggleStarForModel | Star a model if it is unstarred, otherwise unstar the model.
transformRFC3339Period | The DataRobot Monitoring APIs return dates formatted as RFC 3339 strings. This is the same as ISO 8601. Specifically, 'T' is the date/time separator and 'Z' is used to denote UTC. Fractional seconds are returned. e.g. 2020-01-01T05:00:00.000000Z
TreatAsExponential | Treat as exponential
TryingToSubmitNull | Checks to see if we are trying to submit 'NULL' as a value.

## -- U --

UnpauseQueue | Re-start the DataRobot modeling queue
UnstarModel | Unstar a model.
UpdateAccess | Update access to a particular object.
UpdateCalendar | Update a calendar
UpdateComplianceDocTemplate | Update the name or sections of an existing doc template.
UpdateDataSource | Update a data store.
UpdateDataStore | Update a data store.
UpdateDeploymentAssociationId | Deployment Association ID
UpdateDeploymentDriftTrackingSettings | Update drift tracking settings for a deployment.
UpdateFeaturelist | Update a featurelist
UpdateModelingFeaturelist | Update a modeling featurelist
UpdateProject | Update parameters for an existing project
UpdateTransferableModel | Update the display name or note for an imported model.
UploadComplianceDocTemplate | Upload a compliance doc template.
UploadData | Upload a data source.
UploadPredictionDataset | Function to upload new data to a DataRobot project for predictions
UploadPredictionDatasetFromDataSource | Upload a prediction dataset from a data source.
UploadTransferableModel | Import a previously exported model for predictions.

## -- V --

ValidateActuals | Validate that the actuals are a dataframe and contain required columns.
ValidateCalendar | Get a calendar id from a calendar object.
ValidateModel | Validate that model belongs to class 'dataRobotModel' and includes projectId and modelId.
ValidateMultiSeriesProperties | Validate that the multiseries properties indicate a successful multiseries setup.
ValidateParameterIn | Ensure a parameter is valid
ValidatePartition | Checks if a partition is valid.
ValidateProject | Get a projectId from a project object.
ValidateReplaceDeployedModel | Validate a potential deployment model replacement.
validateReportingPeriodTime | Helper function for validating reporting period objects used by the deployment monitoring functions. See 'GetDeploymentServiceStats', 'GetDeploymentAccuracy', 'GetDeploymentServiceStatsOverTime', and 'GetDeploymentAccuracyOverTime'.
VariableTransformTypes | Types of variable transformations
ViewWebModel | Retrieve a DataRobot web page that displays detailed model information
ViewWebProject | Retrieve a DataRobot web page that displays detailed project information

## -- W --

WaitForAutopilot | This function periodically checks whether Autopilot is finished and returns only after it is.
WaitForJobToComplete | Wait for specified job to complete