Usage
linarr(Y, Y_den, id = NULL, age, pl085, month_at_work, weight = NULL, sort = NULL, Dom = NULL, period = NULL, dataset = NULL, order_quant = 50, var_name = "lin_arr")
Arguments
Y
Numerator variable (for gross pension income). One dimensional object convertible to one-column data.table
or variable name as character, column number.
Y_den
Denominator variable (for example gross individual earnings). One dimensional object convertible to one-column data.table
or variable name as character, column number.
id
Optional variable for unit ID codes. One dimensional object convertible to one-column data.table
or variable name as character, column number.
weight
Optional weight variable. One dimensional object convertible to one-column data.table
or variable name as character, column number.
age
Age variable. One dimensional object convertible to one-column data.table
or variable name as character, column number.
pl085
Retirement variable (Number of months spent in retirement or early retirement). One dimensional object convertible to one-column data.table
or variable name as character, column number.
month_at_work
Variable for total number of month at work (sum of the number of months spent at full-time work as employee, number of months spent at part-time work as employee, number of months spent at full-time work as self-employed (including family worker), number of months spent at part-time work as self-employed (including family worker)). One dimensional object convertible to one-column data.table
or variable name as character, column number.
sort
Optional variable to be used as tie-breaker for sorting. One dimensional object convertible to one-column data.table
or variable name as character, column number.
Dom
Optional variables used to define population domains. If supplied, linearization of at-risk-of-poverty threshold is done for each domain. An object convertible to data.table
or variable names as character vector, column numbers as numeric vector.
period
Optional variable for survey period. If supplied, linearization of at-risk-of-poverty threshold is done for each survey period. Object convertible to data.table
or variable names as character, column numbers as numeric vector.
dataset
Optional survey data object convertible to data.table
.
order_quant
A numeric value in range $[0,100]$ for $\alpha$ in the formula for at-risk-of-poverty threshold computation:
$$\frac{p}{100} \cdot Z_{\frac{\alpha}{100}}.$$
For example, to compute at-risk-of-poverty threshold equal to some percentage of median income, $\alpha$ should be set equal to 50.
var_name
A character specifying the name of the linearized variable.