ge: Generalized entropy inequality index

View source: R/ge.R

geR Documentation

Generalized entropy inequality index

Description

This function estimates members of the Generalized Entropy family of inequality indices.

Usage

ge(
  x,
  w = rep(1, length(x)),
  eta = 2,
  data = NULL,
  ranked = x,
  na.rm = TRUE,
  ...
)

Arguments

x

a numerical vector whose index is to be estimated

w

an optional vector of non-negative integer values weights.

eta

the inequality aversion parameter, \eta \ge 0. Larger values place more weight on the inequality of high incomes.

data

the data frame where the variables are found.

na.rm

a logical indicating whether NA's should removed.

Details

If \eta = 0, ge() estimates Theils 0 index, for \eta = 1 ge() estimate Thiels log mean difference. If \eta = 2, ge is 1/2 of the square coefficient of variation, \frac{\sigma^2_x}{2\mu_x}.

Value

The inequality index.

Author(s)

Markus Jantti markus.jantti@iki.fi

References

\insertRef

lambert1993incdist

See Also

gini atkinson

Examples


ge(runif(100), eta = 2)


mjantti/incdist documentation built on Aug. 23, 2023, 5:33 p.m.