ineqExplained: Retrieve a measure of explained inequality from a model

In LorenzRegression: Lorenz and Penalized Lorenz Regressions

Retrieve a measure of explained inequality from a model

Description

This generic function extracts a measure of explained inequality, such as the explained Gini coefficient or the Lorenz-R2, from a fitted model object.

Usage

ineqExplained(object, type = c("Gini.explained", "Lorenz-R2"), ...)

Arguments

object	An object for which the inequality metrics should be extracted.
type	Character string specifying the type of inequality metric to retrieve. Options are "Gini.explained" for the explained Gini coefficient or "Lorenz-R2" for the Lorenz-R^2.
...	Additional arguments passed to specific methods.

Value

The requested inequality metric.

See Also

Lorenz.Reg

Examples

## For examples see example(Lorenz.Reg)

LorenzRegression documentation built on June 27, 2025, 9:07 a.m.