summary.PLR {LorenzRegression} | R Documentation |
Provides a summary for an object of class "PLR"
.
## S3 method for class 'PLR'
summary(object, renormalize = TRUE, ...)
object |
An object of class |
renormalize |
A logical value determining whether the coefficient vector should be re-normalized to match the representation where the first category of each categorical variable is omitted. Default value is TRUE |
... |
Additional arguments |
An object of class "summary.PLR"
, which contains:
call
The matched call.
ineq
A table of explained inequality metrics. The columns display the explained Gini coefficient, the Gini coefficient of the response, and the Lorenz-R2. The first row contains the results obtained by BIC.
coefficients
A matrix with estimated coefficients, each row corresponding to a specific coefficient. The first column contains the results obtained by BIC.
If the object inherits from "PLR_boot"
, ineq
and coefficients
also include results from bootstrap, and the class "summary.PLR_boot"
is added to the output.
Similarly, if the object inherits from "PLR_cv"
, ineq
and coefficients
also include results from cross-validation, and the class "summary.PLR_cv"
is added to the output.
Lorenz.Reg
, Lorenz.boot
, PLR.CV
## For examples see example(Lorenz.Reg), example(Lorenz.boot) and example(PLR.CV)