ineqExplained.PLR

ineqExplained.PLR_boot

ineqExplained.PLR_cv

Retrieves the explained Gini coefficient or the Lorenz-\(R^2\) from an object of class <code>"PLR"</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.PLR function

<dl><dt>object</dt>
<dd>An object of S3 class <code>"PLR"</code>. The object might also have S3 classes <code>"PLR_boot"</code> and/or <code>"PLR_cv"</code> (both inherit from class <code>"PLR"</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>pars.idx</dt>
<dd>What grid and penalty parameters should be used for parameter selection. Either a character string specifying the selection method, where the possible values are:<ul>
<li><code>"BIC"</code> (default) - Always available.</li>
<li><code>"Boot"</code> - Available if <code>object</code> inherits from <code>"PLR_boot"</code>.</li>
<li><code>"CV"</code> - Available if <code>object</code> inherits from <code>"PLR_cv"</code>.</li>
</ul>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.</dd>
<dt>...</dt>
<dd>Additional arguments.</dd></dl>

Arguments

Explained inequality metrics for the penalized Lorenz regression — ineqExplained.PLR

<dl>

<dt>object</dt>
<dd>An object of S3 class <code>"PLR"</code>. The object might also have S3 classes <code>"PLR_boot"</code> and/or <code>"PLR_cv"</code> (both inherit from class <code>"PLR"</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>pars.idx</dt>
<dd>What grid and penalty parameters should be used for parameter selection. Either a character string specifying the selection method, where the possible values are:<ul>
<li><code>"BIC"</code> (default) - Always available.</li>
<li><code>"Boot"</code> - Available if <code>object</code> inherits from <code>"PLR_boot"</code>.</li>
<li><code>"CV"</code> - Available if <code>object</code> inherits from <code>"PLR_cv"</code>.</li>
</ul>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.</dd>


<dt>...</dt>
<dd>Additional arguments.</dd>

</dl>

ineqExplained.PLR: Explained inequality metrics for the penalized Lorenz regression

Description

Usage

Value

Arguments