ineq: calculate a lifespan inequality measure

View source: R/indices.R

ineqR Documentation

calculate a lifespan inequality measure

Description

Choose from variance var, standard deviation sd, coefficient of variation cov, interquartile range iqr, gini, absolute inter individual difference (both age at death and remaining life), drewnowski (complement of Gini), aid (relative Gini), edag e-dagger, Kannisto's compression measure cp, eta_dag the mean age at death lost at death (that we just made up), Leser-Keyfitz entropy H (elasticity of life expectancy to proportional age specific changes in mortality),ineq_rel_eta_dag (a relative version of eta_dag), theil, mean log deviation mld, mean absolute deviation mad (wrt mean or median).

Usage

ineq(
  age,
  dx,
  lx,
  ex,
  ax,
  method = c("var", "sd", "cov", "iqr", "aid", "gini", "drewnowski", "mld", "edag",
    "eta_dag", "cp", "theil", "H", "ineq_rel_eta_dag", "mad"),
  distribution_type,
  check = TRUE,
  ...
)

Arguments

age

numeric. vector of lower age bounds.

dx

numeric. vector of the lifetable death distribution.

lx

numeric. vector of the lifetable survivorship.

ex

numeric. vector of remaining life expectancy.

ax

numeric. vector of the average time spent in the age

method

one of c("var","sd","cov","iqr","aid","gini","drewnowski","mld","edag","eta_dag","cp","theil","H","ineq_rel_eta_dag","mad")

distribution_type

character, either "rl" for remaining life, or "aad" for age at death.

check

logical. Shall we perform basic checks on input vectors? Default TRUE

...

other optional arguments used by particular methods.

Details

The argument distribution_type is only relevant for relative indices. Different indices have different default values for this argument.


alysonvanraalte/LifeIneq documentation built on March 12, 2024, 1:42 p.m.