ineqExplained {LorenzRegression} | R Documentation |
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 |
... |
Additional arguments passed to specific methods. |
Value
The requested inequality metric.
See Also
Examples
## For examples see example(Lorenz.Reg)
[Package LorenzRegression version 2.2.0 Index]