eqInc: Equivalized disposable income

View source: R/eqInc.R

eqIncR Documentation

Equivalized disposable income

Description

Compute the equivalized disposable income from household and personal income variables.

Usage

eqInc(hid, hplus, hminus, pplus, pminus, eqSS, year = NULL, data = NULL)

Arguments

hid

if data=NULL, a vector containing the household ID. Otherwise a character string specifying the column of data that contains the household ID.

hplus

if data=NULL, a data.frame containing the household income components that have to be added. Otherwise a character vector specifying the columns of data that contain these income components.

hminus

if data=NULL, a data.frame containing the household income components that have to be subtracted. Otherwise a character vector specifying the columns of data that contain these income components.

pplus

if data=NULL, a data.frame containing the personal income components that have to be added. Otherwise a character vector specifying the columns of data that contain these income components.

pminus

if data=NULL, a data.frame containing the personal income components that have to be subtracted. Otherwise a character vector specifying the columns of data that contain these income components.

eqSS

if data=NULL, a vector containing the equivalized household size. Otherwise a character string specifying the column of data that contains the equivalized household size. See eqSS for more details.

year

if data=NULL, a vector containing the year of the survey. Otherwise a character string specifying the column of data that contains the year.

data

a data.frame containing EU-SILC survey data, or NULL.

Details

All income components should already be imputed, otherwise NAs are simply removed before the calculations.

Value

A numeric vector containing the equivalized disposable income for every individual in data.

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.

See Also

eqSS

Examples

data(eusilc)

# compute a simplified version of the equivalized disposable income
# (not all income components are available in the synthetic data)
hplus <- c("hy040n", "hy050n", "hy070n", "hy080n", "hy090n", "hy110n")
hminus <- c("hy130n", "hy145n")
pplus <- c("py010n", "py050n", "py090n", "py100n",
    "py110n", "py120n", "py130n", "py140n")
eqIncome <- eqInc("db030", hplus, hminus,
    pplus, character(), "eqSS", data=eusilc)

# combine with household ID and equivalized household size
tmp <- cbind(eusilc[, c("db030", "eqSS")], eqIncome)

# show the first 8 rows
head(tmp, 8)


laeken documentation built on May 29, 2024, 4:42 a.m.