GetValidMetrics: Retrieve the valid fitting metrics for a specified project...

View source: R/GetValidMetrics.R

GetValidMetricsR Documentation

Retrieve the valid fitting metrics for a specified project and target

Description

For the response variable defined by the character string target and the project defined by the parameter project, return the vector of metric names that can be specified for fitting models in this project. This function is intended for use after SetupProject has been run but before SetTarget, allowing the user to specify valid non-default values for the metric parameter.

Usage

GetValidMetrics(project, target)

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.

target

character. String giving the name of the response variable to be predicted by all project models.

Value

Character vector containing the names of the metric values that are valid for a subsequent call to the SetTarget function.

Examples

## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  GetValidMetrics(projectId, "targetFeature")

## End(Not run)

datarobot documentation built on May 29, 2024, 4:36 a.m.