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

View source: R/ResidualsChart.R

ListResidualsChartsR Documentation

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.

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

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:

  • residualMean. Numeric: the arithmetic mean of the predicted value minus the actual value over the downsampled dataset.

  • coefficientOfDetermination. Numeric: aka the r-squared value. This value is calculated over the downsampled output, not the full input.

  • data. data.frame: The rows of chart data in [actual, predicted, residual, row number] form. If the row number was not available at the time of model creation, the row number will be null.

  • histogram. list: Data to plot a histogram of residual values. Each object contains:

    • intervalStart. Numeric: Start value for an interval, inclusive.

    • intervalEnd. Numeric: End value for an interval, exclusive for all but the last interval.

    • occurrences. Integer: the number of times the predicted value fits within the interval.

Examples

## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  modelId <- "5996f820af07fc605e81ead4"
  model <- GetModel(projectId, modelId)
  ListResidualsCharts(model)

## End(Not run)

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