Effect size calculations for heteroscedasticity diagnostics

Source: R/effect_sizes.R · Help: ?rcalculateEffectSize

Converts chi-squared statistics produced by heteroscedasticity tests into interpretable effect sizes such as Cramer's V, the phi coefficient, or an eta-squared analogue. The helper also provides qualitative magnitude descriptors and a brief interpretation string that can be surfaced to users.

Usage

rcalculateEffectSize(
  test_result,
  model,
  data,
  type = c("cramers_v", "phi", "eta_squared")
)

Arguments

test_result

Result object from a heteroscedasticity test (typically of class htest).

model

Fitted model supplied to the diagnostic.

data

Data frame containing the variables referenced in model.

type

Effect size metric to compute. Supported options are "cramers_v", "phi", and "eta_squared".

Value

A named list with elements effect_size, magnitude, practical_significance, interpretation, and type.

Deprecated

Deprecated since 0.14.0: an internal helper of the package, which leaves the exports in 1.0.0. It still works and warns.

Examples

data(mtcars)
model <- lm(mpg ~ wt + cyl, data = mtcars)
result <- performWhiteTest(model, mtcars)
rcalculateEffectSize(result, model, mtcars)