utils: Utility functions for indicators on social exclusion and poverty

Description

Test for class, print and take subsets of indicators on social exclusion and poverty.

Usage

is.indicator(x)
is.arpr(x)
is.qsr(x)
is.rmpg(x)
is.gini(x)
is.prop(x)
is.gpg(x)
# S3 method for indicator
print(x, ...)
# S3 method for arpr
print(x, ...)
# S3 method for rmpg
print(x, ...)
# S3 method for indicator
subset(x, years = NULL, strata = NULL, ...)
# S3 method for arpr
subset(x, years = NULL, strata = NULL, ...)
# S3 method for rmpg
subset(x, years = NULL, strata = NULL, ...)

Value

is.indicator returns TRUE if x inherits from class "indicator" and FALSE otherwise.

is.arpr returns TRUE if x inherits from class "arpr" and FALSE otherwise.

is.qsr returns TRUE if x inherits from class "qsr" and FALSE otherwise.

is.rmpg returns TRUE if x inherits from class "rmpg" and FALSE otherwise.

is.gini returns TRUE if x inherits from class "gini" and FALSE otherwise.

print.indicator, print.arpr and print.rmpg return x invisibly.

subset.indicator, subset.arpr and subset.rmpg return a subset of x of the same class.

Arguments

x: for is.xyz, any object to be tested. The print and subset methods are called by the generic functions if an object of the respective class is supplied.
...: additional arguments to be passed to and from methods.
years: an optional numeric vector giving the years to be extracted.
strata: an optional vector giving the domains of the breakdown to be extracted.

References

A. Alfons and M. Templ (2013) Estimation of Social Exclusion Indicators from Complex Surveys: The R Package laeken. Journal of Statistical Software, 54(15), 1--25. tools:::Rd_expr_doi("10.18637/jss.v054.i15")

Examples

Run this code

data(eusilc)

# at-risk-of-poverty rate
a <- arpr("eqIncome", weights = "rb050",
    breakdown = "db040", data = eusilc)
print(a)
is.arpr(a)
is.indicator(a)
subset(a, strata = c("Lower Austria", "Vienna"))

# quintile share ratio
q <- qsr("eqIncome", weights = "rb050",
    breakdown = "db040", data = eusilc)
print(q)
is.qsr(q)
is.indicator(q)
subset(q, strata = c("Lower Austria", "Vienna"))

# relative median at-risk-of-poverty gap
r <- rmpg("eqIncome", weights = "rb050",
    breakdown = "db040", data = eusilc)
print(r)
is.rmpg(r)
is.indicator(r)
subset(r, strata = c("Lower Austria", "Vienna"))

# Gini coefficient
g <- gini("eqIncome", weights = "rb050",
    breakdown = "db040", data = eusilc)
print(g)
is.gini(g)
is.indicator(g)
subset(g, strata = c("Lower Austria", "Vienna"))