laeken (version 0.3.2)

arpr: At-risk-of-poverty rate

Description

Estimate the at-risk-of-poverty rate, which is defined as the proportion of persons with equivalized disposable income below the at-risk-of-poverty threshold.

Usage

arpr(inc, weights = NULL, sort = NULL, years = NULL, 
     breakdown = NULL, design = NULL, data = NULL, p = 0.6, 
     var = NULL, alpha = 0.05, 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 <

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

breakdown

optional; either a numeric vector giving different strata, or (if data is not NULL) a character string, an integer or a logical vector specifying the corresponding column of data. If supplied, the val

design

optional and only used if var is not NULL; either an integer vector or factor giving different strata for stratified sampling designs, or (if data is not NULL) a character string, an integ

data

an optional data.frame.

p

a numeric value in $[0,1]$ giving the percentage of the weighted median to be used for the at-risk-of-poverty threshold (see arpt).

var

a character string specifying the type of variance estimation to be used, or NULL to omit variance estimation. See variance for possible values.

alpha

numeric; if var is not NULL, this gives the significance level to be used for computing the confidence interval (i.e., the confidence level is $1 -$alpha).

na.rm

a logical indicating whether missing values should be removed.

...

if var is not NULL, additional arguments to be passed to variance.

Value

• A list of class "arpr" (which inherits from the class "indicator") with the following components:
• value
  a numeric vector containing the overall value(s).
• valueByStratum
  a data.frame containing the values by stratum, or NULL.
• varMethod
  a character string specifying the type of variance estimation used, or NULL if variance estimation was omitted.
• var
  a numeric vector containing the variance estimate(s), or NULL.
• varByStratum
  a data.frame containing the variance estimates by stratum, or NULL.
• ci
  a numeric vector or matrix containing the lower and upper endpoints of the confidence interval(s), or NULL.
• ciByStratum
  a data.frame containing the lower and upper endpoints of the confidence intervals by stratum, or NULL.
• alpha
  a numeric value giving the significance level used for computing the confidence interval(s) (i.e., the confidence level is $1 -$alpha), or NULL.
• years
  a numeric vector containing the different years of the survey.
• strata
  a character vector containing the different strata of the breakdown.
• p
  a numeric giving the percentage of the weighted median used for the at-risk-of-poverty threshold.
• threshold
  a numeric vector containing the at-risk-of-poverty threshold(s).

Details

The implementation strictly follows the Eurostat definition.

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, Luxembourg.

See Also

arpt, variance

Examples

data(eusilc)

# overall value
arpr("eqIncome", weights = "rb050", data = eusilc)

# values by region
arpr("eqIncome", weights = "rb050", 
    breakdown = "db040", data = eusilc)