GetLiftChart: Retrieve lift chart data for a model for a data partition...

View source: R/LiftChart.R

GetLiftChartR Documentation

Retrieve lift chart data for a model for a data partition (see DataPartition)

Description

Retrieve lift chart data for a model for a data partition (see DataPartition)

Usage

GetLiftChart(
  model,
  source = DataPartition$VALIDATION,
  fallbackToParentInsights = FALSE
)

Arguments

model

dataRobotModel. A DataRobot model object like that returned by GetModel.

source

character. The data partition for which data would be returned. Default is DataPartition$VALIDATION. See DataPartition for details.

fallbackToParentInsights

logical. If TRUE, this will return the lift chart data for the model's parent if the lift chart is not available for the model and the model has a parent model.

Value

data.frame with the following components:

  • binWeight. Numeric: weight of the bin. For weighted projects, the sum of the weights of all rows in the bin; otherwise, the number of rows in the bin.

  • actual. Numeric: sum of actual target values in bin.

  • predicted. Numeric: sum of predicted target values in bin.

Examples

## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  modelId <- "5996f820af07fc605e81ead4"
  model <- GetModel(projectId, modelId)
  GetLiftChart(model, source = DataPartition$VALIDATION)

## End(Not run)

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