ineqExplained.LR {LorenzRegression}R Documentation

Explained inequality metrics for the Lorenz regression

Description

Retrieves the explained Gini coefficient or the Lorenz-R^2 from an object of class "LR".

Usage

## S3 method for class 'LR'
ineqExplained(object, type = c("Gini.explained", "Lorenz-R2"), ...)

Arguments

object

An object of S3 class "LR".

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.

Value

A numeric value representing the requested inequality metric.


[Package LorenzRegression version 2.1.0 Index]