ListStarredModels: List all the starred models in a project.

View source: R/StarredModels.R

ListStarredModelsR Documentation

List all the starred models in a project.

Description

Star models and add them to this list using StarModel or ToggleStarForModel. Unstar models and remove them from this list using UnstarModel or ToggleStarForModel

Usage

ListStarredModels(project, orderBy = NULL)

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.

orderBy

character. Optional. A vector of keys to order the list by. You can order by metric or samplePct. If the sort attribute is preceded by a hyphen, models will be sorted in descending order, otherwise in ascending order. Multiple sort attributes can be included as a comma-delimited string or in a vector.

Value

An S3 object of class listOfModels, which may be characterized using R's generic summary function or converted to a dataframe with the as.data.frame method.

Examples

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

## End(Not run)

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