score_peak {auditor}

Peak Score

Description

This score is calculated on the basis of Peak test, which is used for checking for homoscedasticity of residuals in regression analyses.

Usage

score_peak(object, variable = NULL, data = NULL, y = NULL, ...)

scorePeak(object)

Arguments

object

An object of class explainer created with function explain from the DALEX package.

variable

Name of model variable to order residuals.

data

New data that will be used to calculate the score. Pass NULL if you want to use data from object.

y

New y parameter will be used to calculate score.

...

Other arguments dependent on the type of score.

Value

An object of class auditor_score.

Examples

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

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

# create an explainer
lm_audit <- audit(model_lm, data = dragons, y = dragons$life_length)

# calculate score
score_peak(lm_audit)