ineqExplained.lm {LorenzRegression} | R Documentation |
Explained inequality metrics for (generalized) linear models
Description
Retrieves the explained Gini coefficient or the Lorenz-R^2
from an object of class "lm"
.
Usage
## S3 method for class 'lm'
ineqExplained(object, type = c("Gini.explained", "Lorenz-R2"), ...)
Arguments
object |
An object of S3 class |
type |
Character string specifying the type of inequality metric to retrieve. Options are |
... |
Additional arguments passed to |
Value
A numeric value representing the requested inequality metric.
[Package LorenzRegression version 2.2.0 Index]