arpr: At-risk-of-poverty rate

Description Usage Arguments Details Value Author(s) References See Also Examples

View source: R/arpr.R

Description

Estimates the poverty rate which is defined as the share of people with an equivalised disposable income below the at-risk-of-poverty threshold.

Usage

1
2
arpr(dataset, ipuc = "ipuc", hhcsw = "DB090", hhsize = "HX040",
  arpt.value = NULL, ci = NULL, rep = 1000, verbose = FALSE)

Arguments

dataset

a data.frame containing the variables.

ipuc

a character string indicating the variable name of the income per unit of consumption. Default is "ipuc".

hhcsw

a character string indicating the variable name of the household cross-sectional weight. Default is "DB090".

hhsize

a character string indicating the variable name of the household size. Default is "HX040".

arpt.value

the at-risk-of-poverty threshold to be used (see arpt). Default is NULL which calculates arpt with default parameters.

ci

a scalar or vector containing the confidence level(s) of the required interval(s). Default does not calculate the confidence interval.

rep

a number to make the confidence interval using boostrap technique.

verbose

logical; if TRUE the confidence interval is plotted.

Details

The equivalised disposable income is calculated using the standard equivalence scale (called the modified OECD scale) recommended by Eurostat. The parametric scale of Buhmann et al. (1988) can also be used. The default is the modified OECD scale (see setupDataset).

Value

The value of the at-risk-of-poverty rate.

Author(s)

A. Berihuete, C.D. Ramos and M.A. Sordo

References

B. Buhmann et al. (1988) Equivalence scales, well-being, inequality and poverty: sensitivity estimates across ten countries using the Luxembourg Income Study (LIS) database, Review of Income and Wealth, 34, 115–142.

http://ec.europa.eu/eurostat/statistics-explained/index.php/Glossary:At-risk-of-poverty_rate

See Also

arpt, setupDataset

Examples

1
2
3
data(eusilc2)
ATdataset <- setupDataset(eusilc2, country = "AT")
arpr(ATdataset,arpt.value = arpt(ATdataset))

rtip documentation built on April 12, 2018, 5:04 p.m.

Related to arpr in rtip...