datarobot (version 2.18.6)

ListProjects: Retrieve a list of all DataRobot projects

Description

This function returns an S3 object of class projectSummaryList that describes all (optionally filtered) DataRobot modeling projects available to the user. This list may be converted into a dataframe with the as.data.frame method for this class of S3 objects.

Usage

ListProjects(filter = NULL, limit = NULL, offset = NULL)

Value

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

• projectId. List of character strings giving the unique DataRobot identifier for each project.

• projectName. List of character strings giving the user-supplied project names.

• fileName. List of character strings giving the name of the modeling dataset for each project.

• stage. List of character strings specifying each project's Autopilot stage (e.g., 'aim' is necessary to set target). Use ProjectStage to get a list of options.

• autopilotMode. List of integers specifying the Autopilot mode (0 = fully automatic, 1 = semi-automatic, 2 = manual).

• created. List of character strings giving the project creation time and date.

• target. List of character strings giving the name of the target variable for each project.

• metric. List of character strings identifying the fitting metric optimized for each project.

• partition. Dataframe with one row for each project and 12 columns specifying partitioning details.

• advancedOptions. Dataframe with one row for each project and 4 columns specifying values for advanced option parameters.

• positiveClass. Character string identifying the positive target class for binary classification projects.

• 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. Logical flag indicating whether holdout subset results have been computed.

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

Arguments

filter

list. Optional. A named list that can be used to specify various filters. Currently `projectName` is supported which will filter returned projects for projects with names containing the specified string.

limit

integer. Optional. At most this many results are returned. Invoking `ListProjects` with this value against DataRobot 8.x (API 2.28) or older will throw an error.

offset

integer. Optional. This many results will be skipped. Invoking `ListProjects` with this value against DataRobot 8.x (API 2.28) or older will throw an error.

Examples

if (FALSE) {
  ListProjects()
  ListProjects(filter = list("projectName" = "TimeSeries"))
}