ListResidualsCharts: Retrieve residuals chart data for a model for all available...

Description Usage Arguments Value Examples

View source: R/ResidualsChart.R

Description

Retrieve residuals chart data for a model for all available data partitions (see DataPartition). This chart is only available for regression models that are not time-aware.

Usage

1
ListResidualsCharts(model, fallbackToParentInsights = FALSE)

Arguments

model

dataRobotModel. A DataRobot model object like that returned by GetModel. The model must be a regression model that is not time-aware.

fallbackToParentInsights

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

Value

list of objects containing residuals chart data for all available data partitions. See DataPartition for details. Each object has the following components:

Examples

1
2
3
4
5
6
7
## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  modelId <- "5996f820af07fc605e81ead4"
  model <- GetModel(projectId, modelId)
  ListResidualsCharts(model)

## End(Not run)

datarobot documentation built on June 2, 2021, 9:06 a.m.