GetProject: Retrieve details about a specified DataRobot modeling project

In datarobot: 'DataRobot' Predictive Modeling API

Retrieve details about a specified DataRobot modeling project

Description

Returns a list of details about the DataRobot modeling project specified by project.

Usage

GetProject(project)

Arguments

project

character. Either (1) a character string giving the unique alphanumeric identifier for the project, or (2) a list containing the element projectId with this identifier.

Value

An S3 object of class 'dataRobotProject', consisting of the following elements:

• projectId. Character string giving the unique project identifier.

• projectName. Character string giving the name assigned to the project.

• fileName. Character string giving the name of the modeling dataset for the project.

• stage. Character string describing the stage of the DataRobot Autopilot.

• autopilotMode. Numeric: 0 for fully automatic mode; 1 for semi-automatic mode; 2 for manual mode.

• created. Character string representation of the project creation time and date.

• target. Name of the target variable from fileName.

• metric. Character string specifying the metric optimized by all project models.

• partition. A 7-element list describing the data partitioning for model fitting and cross validation.

• advancedOptions. A 4-element list with advanced option specifications.

• positiveClass. Character string: name of positive class for binary response models.

• maxTrainPct. The maximum percentage of the project dataset that can be used without going into the validation data or being too large to submit any blueprint for training a project.

• maxTrainRows. The maximum number of rows that can be trained on without going into the validation data or being too large to submit any blueprint for training.

• holdoutUnlocked. A logical flag indicating whether the holdout dataset has been used for model evaluation.

• targetType. Character string specifying the type of modeling problem (e.g., regression or binary classification).

Examples

## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  GetProject(projectId)

## End(Not run)

datarobot documentation built on Nov. 3, 2023, 1:07 a.m.