DataRobot Predictive Modeling API


[Up] [Top]

Documentation for package ‘datarobot’ version 2.6.0

Help Pages

A B C D F G J L P R S U V W

datarobot-package datarobot: DataRobot Predictive Modeling API

-- A --

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
AutopilotMode Autopilot modes

-- B --

BlendMethods Blend methods
BlueprintChartToGraphviz Convert a blueprint chart into graphviz DOT format

-- C --

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
CreateDatetimePartitionSpecification Create a list describing datetime partition parameters
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
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
CreateStratifiedPartition Create a stratified sampling-based S3 object of class partition for the SetTarget function
CreateUserPartition Create a user-defined S3 object of class partition for the SetTarget function
cvMethods CV methods

-- D --

datarobot datarobot: DataRobot Predictive Modeling API
DeleteJob Cancel a running job
DeleteModel Delete a specified DataRobot model
DeleteModelJob Delete a model job from the modeling queue
DeletePredictionDataset Delete a specified prediction dataset
DeletePredictJob Function to delete one predict job from the DataRobot queue
DeleteProject Delete a specified element from the DataRobot project list
DeleteReasonCodes Function to delete reason codes
DeleteReasonCodesInitialization Delete the reason codes initialization for a model.
DeleteTransferrableModel Delete this imported model.
DownloadPrimeCode Download the code of DataRobot Prime model and save it to a file
DownloadReasonCodes Function to download and save reason codes rows as csv file
DownloadTransferrableModel Download 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.

-- F --

FeatureFromAsyncUrl Retrieve a feature from the creation URL

-- G --

GenerateDatetimePartition Preview the full partitioning determined by a DatetimePartitioningSpecification
GetAllModels Retrieve all available model information for a DataRobot project
GetAllReasonCodesRowsAsDataFrame Retrieve all reason codes rows and return them as a data frame
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
GetBlueprintDocuments Get documentation for tasks used in the blueprint
GetDatetimeModelFromJobId Retrieve a new or updated datetime model defined by modelJobId
GetDatetimeModelObject Retrieve the details of a specified datetime model
GetDatetimePartition Retrieve the DatetimePartitioning from a project
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
GetModelFromJobId Retrieve a new or updated model defined by modelJobId
GetModelJobs Retrieve status of Autopilot modeling jobs that are not complete
GetModelObject Retrieve the details of a specified model
GetModelParameters Retrieve model parameters
GetPredictions Retrieve model predictions from predictJobId
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 dtails about a specified DataRobot modeling project
GetProjectList Retrieve a list of all DataRobot projects
GetProjectStatus Request Autopilot status for a specified DataRobot project
GetReasonCodesInitialization Retrieve the reason codes initialization for a model.
GetReasonCodesInitializationFromJobId Retrieve the reason codes initialization for a model using jobId
GetReasonCodesMetadata Retrieve metadata for specified reason codes
GetReasonCodesMetadataFromJobId Retrieve the reason codes metadata for a model using jobId
GetReasonCodesRows Retrieve all reason codes rows
GetRecommendedBlueprints Retrieve the list of available blueprints for a project
GetRulesets List the rulesets approximating a model generated by DataRobot Prime
GetTransferrableModel Retrieve imported model info using import id
GetValidMetrics Retrieve the valid fitting metrics for a specified project and target

-- J --

JobStatus Job statuses
JobType Job type

-- L --

ListBlueprints Retrieve the list of available blueprints for a project
ListFeatureInfo Details about all features for this project
ListFeaturelists Retrieve all featurelists associated with a project
ListJobs Retrieve information about jobs
ListModelFeatures Returns the list of features (i.e., variables) on which a specified model is based
ListPredictionDatasets Retrieve all prediction datasets associated with a project
ListPrimeFiles List all downloadable code files from DataRobot Prime for the project
ListPrimeModels Retrieve information about all DataRobot Prime models for a DataRobot project
ListReasonCodesMetadata Retrieve metadata for reason codes in specified project
ListTransferrableModels Retrieve information about all imported models This function returns a data.frame that describes all imported models

-- P --

PauseQueue Pause the DataRobot modeling queue
plot.listOfModels Plot method for DataRobot S3 objects of class listOfModels
PostgreSQLdrivers PostgreSQL drivers
PredictionDatasetFromAsyncUrl Retrieve prediction dataset info from the dataset creation URL
PrimeLanguage Prime Language
ProjectFromAsyncUrl Retrieve a project from the project-creation URL

-- R --

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.
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
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
RequestPredictions Request predictions for model from newdata
RequestPredictionsForDataset Request predictions against a previously uploaded dataset
RequestPrimeModel Request training for a DataRobot Prime model using a specified ruleset
RequestReasonCodes Request reason codes computation for a specified model and dataset.
RequestReasonCodesInitialization Request reason codes initialization for specified model
RequestSampleSizeUpdate Refits an existing model to a different fraction of the training dataset
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. Example: jobId<-RequestTransferrrableModel(projectObject, modelId) WaitForJobToComplete(projectObject, jobId) DownloadTransferrableModel(projectObject, modelId, file)

-- S --

ScoreBacktests Compute the scores for all available backtests
SetTarget Set the target variable (and by default, start the DataRobot Autopilot)
SetupProject Function to set up a new DataRobot project
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
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
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.
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.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

-- U --

UnpauseQueue Re-start the DataRobot modeling queue
UpdateProject Update parameters for an existing project
UpdateTransferrableModel Update the display name or note for an imported model.
UploadPredictionDataset Function to upload new data to a DataRobot project for predictions
UploadTransferrableModel Import a previously exported model for predictions.

-- V --

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