plot_tsecdf: Two-sided Cumulative Distribution Function

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

Two-sided Cumulative Distribution Function

Description

Cumulative Distribution Function for positive and negative residuals.

Usage

plot_tsecdf(
  object,
  ...,
  scale_error = TRUE,
  outliers = NA,
  residuals = TRUE,
  reverse_y = FALSE
)

plotTwoSidedECDF(
  object,
  ...,
  scale_error = TRUE,
  outliers = NA,
  residuals = TRUE,
  reverse_y = FALSE
)

Arguments

object	An object of class 'auditor_model_residual' created with model_residual function.
...	Other modelAudit objects to be plotted together.
scale_error	A logical value indicating whether ECDF should be scaled by proportions of positive and negative proportions.
outliers	Number of outliers to be marked.
residuals	A logical value indicating whether residuals should be marked.
reverse_y	A logical value indicating whether values on y axis should be reversed.

Value

A ggplot 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_tsecdf(mr_lm)
plot(mr_lm, type="tsecdf")

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_tsecdf(mr_lm, mr_rf, reverse_y = TRUE)

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