ineqExplained.PLR {LorenzRegression} | R Documentation |
Explained inequality metrics for the penalized Lorenz regression
Description
Retrieves the explained Gini coefficient or the Lorenz-R^2
from an object of class "PLR"
.
Usage
## S3 method for class 'PLR'
ineqExplained(
object,
type = c("Gini.explained", "Lorenz-R2"),
pars.idx = "BIC",
...
)
Arguments
object |
An object of S3 class |
type |
Character string specifying the type of inequality metric to retrieve. Options are |
pars.idx |
What grid and penalty parameters should be used for parameter selection. Either a character string specifying the selection method, where the possible values are:
Or a numeric vector of length 2, where the first element is the index of the grid parameter and the second is the index of the penalty parameter. |
... |
Additional arguments. |
Value
A numeric value representing the requested inequality metric.