laeken: arpt – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

arpt

At-risk-of-poverty threshold

Description

Estimate the at-risk-of-poverty threshold. The standard definition is to use 60% of the weighted median equivalized disposable income.

Usage

arpt(inc, weights = NULL, sort = NULL, years = NULL, data = NULL,
  p = 0.6, na.rm = FALSE)

Arguments

`inc`	either a numeric vector giving the equivalized disposable income, or (if `data` is not `NULL`) a character string, an integer or a logical vector specifying the corresponding column of `data`.
`weights`	optional; either a numeric vector giving the personal sample weights, or (if `data` is not `NULL`) a character string, an integer or a logical vector specifying the corresponding column of `data`.
`sort`	optional; either a numeric vector giving the personal IDs to be used as tie-breakers for sorting, or (if `data` is not `NULL`) a character string, an integer or a logical vector specifying the corresponding column of `data`.
`years`	optional; either a numeric vector giving the different years of the survey, or (if `data` is not `NULL`) a character string, an integer or a logical vector specifying the corresponding column of `data`. If supplied, values are computed for each year.
`data`	an optional `data.frame`.
`p`	a numeric vector of values in [0,1] giving the percentages of the weighted median to be used for the at-risk-of-poverty threshold.
`na.rm`	a logical indicating whether missing values should be removed.

Details

The implementation strictly follows the Eurostat definition.

Value

A numeric vector containing the value(s) of the at-risk-of-poverty threshold is returned.

Author(s)

Andreas Alfons

References

Working group on Statistics on Income and Living Conditions (2004) Common cross-sectional EU indicators based on EU-SILC; the gender pay gap. EU-SILC 131-rev/04, Eurostat.

Examples

data(eusilc)
arpt("eqIncome", weights = "rb050", data = eusilc)

laeken

Estimation of Indicators on Social Exclusion and Poverty

v0.5.1

GPL (>= 2)

Authors

Andreas Alfons [aut, cre], Josef Holzer [aut], Matthias Templ [aut], Alexander Haider [ctb]

Initial release

2020-02-05