plotD3_acf: Plot Autocorrelation Function in D3 with r2d3 package.

In auditor: Model Audit - Verification, Validation, and Error Analysis

Plot Autocorrelation Function in D3 with r2d3 package.

Description

Plot Autocorrelation Function of models' residuals.

Usage

plotD3_acf(object, ..., variable = NULL, alpha = 0.95, scale_plot = FALSE)

plotD3ACF(object, ..., variable = NULL, alpha = 0.95, scale_plot = FALSE)

Arguments

object	An object of class 'auditor_model_residual' created with model_residual function.
...	Other 'auditor_model_residual' objects to be plotted together.
variable	Name of variable to order residuals on a plot. If variable="_y_", the data is ordered by a vector of actual response (y parameter passed to the explain function). If variable = "_y_hat_" the data on the plot will be ordered by predicted response. If variable = NULL, unordered observations are presented.
alpha	Confidence level of the interval.
scale_plot	Logical, indicates whenever the plot should scale with height. By default it's FALSE.

Value

a 'r2d3' object.

Examples

dragons <- DALEX::dragons[1:100, ]

# fit a model
model_lm <- lm(life_length ~ ., data = dragons)

lm_audit <- audit(model_lm, data = dragons, y = dragons$life_length)

# validate a model with auditor
mr_lm <- model_residual(lm_audit)

# plot results
plotD3_acf(mr_lm)

library(randomForest)
model_rf <- randomForest(life_length~., data = dragons)
rf_audit <- audit(model_rf, data = dragons, y = dragons$life_length)
mr_rf <- model_residual(rf_audit)
plotD3_acf(mr_lm, mr_rf)

auditor documentation built on Nov. 2, 2023, 6:13 p.m.