Usage
linarpr(Y, id = NULL, weight = NULL, Y_thres = NULL, wght_thres = NULL, sort = NULL, Dom = NULL, period = NULL, dataset = NULL, percentage = 60, order_quant = 50, var_name = "lin_arpr")
Arguments
Y
Study variable (for example equalized disposable income). 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 or logical vector).
weight
Optional weight variable. One dimensional object convertible to one-column data.table
or variable name as character, column number or logical vector).
Y_thres
Variable (for example equalized disposable income) used for computation and linearization of poverty threshold. One dimensional object convertible to one-column data.table
or variable name as character, column number. Variable specified for inc
is used as income_thres
if income_thres
is not defined.
wght_thres
Weight variable used for computation and linearization of poverty threshold. One dimensional object convertible to one-column data.table
or variable name as character, column number or logical vector. Variable specified for weight
is used as wght_thres
if wght_thres
is not defined.
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
.
percentage
A numeric value in range $[0,100]$ for $p$ 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 60% of some income quantile, $p$ should be set equal to 60.
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.