ineqExplained.lm

Retrieves the explained Gini coefficient or the Lorenz-\(R^2\) from an object of class <code>"lm"</code>.

Inference for the Lorenz and penalized Lorenz regressions. More broadly, the package proposes functions to assess inequality and graphically represent it. The Lorenz Regression procedure is introduced in Heuchenne and Jacquemain (2022) <doi:10.1016/j.csda.2021.107347> and in Jacquemain, A., C. Heuchenne, and E. Pircalabelu (2024) <doi:10.1214/23-EJS2200>.

Alexandre Jacquemain

LorenzRegression

Lorenz and Penalized Lorenz Regressions

Xingjie Shi

ineqExplained.lm function

<dl><dt>object</dt>
<dd>An object of S3 class <code>"lm"</code>.</dd>
<dt>type</dt>
<dd>Character string specifying the type of inequality metric to retrieve. Options are <code>"Gini.explained"</code> (for the explained Gini coefficient) and <code>"Lorenz-R2"</code> (for the Lorenz-\(R^2\)).</dd>
<dt>...</dt>
<dd>Additional arguments passed to <code>Gini.coef</code>.</dd></dl>

Arguments

Explained inequality metrics for (generalized) linear models — ineqExplained.lm

<dl>

<dt>object</dt>
<dd>An object of S3 class <code>"lm"</code>.</dd>


<dt>type</dt>
<dd>Character string specifying the type of inequality metric to retrieve. Options are <code>"Gini.explained"</code> (for the explained Gini coefficient) and <code>"Lorenz-R2"</code> (for the Lorenz-\(R^2\)).</dd>


<dt>...</dt>
<dd>Additional arguments passed to <code>Gini.coef</code>.</dd>

</dl>

ineqExplained.lm: Explained inequality metrics for (generalized) linear models

Description

Usage

Value

Arguments