ineqExplained.lm: Explained inequality metrics for (generalized) linear models
In LorenzRegression: Lorenz and Penalized Lorenz Regressions
View source: R/ineqExplained.R
ineqExplained.lm 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 "lm".
type
Character string specifying the type of inequality metric to retrieve. Options are "Gini.explained" (for the explained Gini coefficient) and "Lorenz-R2" (for the Lorenz-R^2).
...
Additional arguments passed to Gini.coef.
Value
A numeric value representing the requested inequality metric.
LorenzRegression documentation built on June 27, 2025, 9:07 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/ineqExplained.R
| ineqExplained.lm | 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.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.