GetModelingFeaturelist: Retrieve a specific modeling featurelist from a DataRobot...

View source: R/Featurelists.R

GetModelingFeaturelistR Documentation

Retrieve a specific modeling featurelist from a DataRobot project

Description

In time series projects, a new set of modeling features is created after setting the partitioning options. These features are automatically derived from those in the project's dataset and are the features used for modeling. Modeling features are only accessible once the target and partitioning options have been set. In projects that don't use time series modeling, once the target has been set, ModelingFeaturelists and Featurelists will behave the same.

Usage

GetModelingFeaturelist(project, featurelistId)

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.

featurelistId

Unique alphanumeric identifier for the featurelist to be retrieved.

Value

A list with the following elements describing the requested featurelist:

  • featurelistId character. The unique alphanumeric identifier for the featurelist.

  • projectId character. The project to which the featurelist belongs.

  • features character. The names of the variables included in the featurelist.

  • name character. The name of the featurelist.

  • created character. A timestamp of when the featurelist was created.

  • isUserCreated logical. Whether or not the featurelist was created by a user (as opposed to DataRobot automation).

  • numModels numeric. The number of models that currently use this featurelist.

Examples

## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  featureList <- CreateModelingFeaturelist(projectId, "myFeaturelist", c("feature1", "feature2"))
  featurelistId <- featureList$featurelistId
  GetModelingFeaturelist(projectId, featurelistId)

## End(Not run)

datarobot documentation built on May 6, 2022, 5:06 p.m.