plot_residual_density: Residual Density Plot

View source: R/plot_residual_density.R

plot_residual_densityR Documentation

Residual Density Plot

Description

Density of model residuals.

Usage

plot_residual_density(object, ..., variable = "", show_rugs = TRUE)

plotResidualDensity(object, ..., variable = NULL)

Arguments

object

An object of class auditor_model_residual created with model_residual function.

...

Other auditor_model_residual objects to be plotted together.

variable

Split plot by variable's factor level or median. If variable="_y_", the plot will be split by actual response (y parameter passed to the explain function). If variable = "_y_hat_" the plot will be split by predicted response. If variable = NULL, the plot will be split by observation index If variable = "" plot is not split (default option).

show_rugs

Adds rugs layer to the plot. By default it's TRUE

Value

A ggplot object.

See Also

plot_residual

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
plot_residual_density(mr_lm)
plot(mr_lm, type = "residual_density")

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)
plot_residual_density(mr_lm, mr_rf)
plot(mr_lm, mr_rf, type = "residual_density")


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