convey (version 0.2.2)

svysen: Sen (1976) poverty index (EXPERIMENTAL)

Description

Estimate the Sen (1976) poverty measure.

Usage

svysen(formula, design, ...)
# S3 method for survey.design
svysen(
  formula,
  design,
  abs_thresh = NULL,
  na.rm = FALSE,
  components = FALSE,
  ...
)
# S3 method for svyrep.design
svysen(
  formula,
  design,
  abs_thresh = NULL,
  na.rm = FALSE,
  components = FALSE,
  ...
)
# S3 method for DBIsvydesign
svysen(formula, design, ...)

Arguments

formula

a formula specifying the income variable

design

a design object of class survey.design or class svyrep.design from the survey library.

...

future expansion

abs_thresh

poverty threshold value

na.rm

Should cases with missing values be dropped?

components

Keep estimates of FGT(0), FGT(1), Gini index of poor incomes.

Value

Object of class "cvystat", which are vectors with a "var" attribute giving the variance and a "statistic" attribute giving the name of the statistic.

Details

you must run the convey_prep function on your survey design object immediately after creating it with the svydesign or svrepdesign function.

References

Amartya K. Sen (1976). Poverty: An Ordinal Approach to Measurement. Econometrica, v. 44, n. 3, pp. 219-231. URL http://www.jstor.org/stable/1912718.

See Also

svysst, svyfgt, svygini.

Examples

# NOT RUN {
library(survey)
library(laeken)
data(eusilc) ; names( eusilc ) <- tolower( names( eusilc ) )

# linearized design

des_eusilc <- svydesign( ids = ~rb030 , strata = ~db040 ,  weights = ~rb050 , data = eusilc )
des_eusilc <- convey_prep( des_eusilc )

# replicate-weighted design
des_eusilc_rep <- as.svrepdesign( des_eusilc , type = "bootstrap" )
des_eusilc_rep <- convey_prep( des_eusilc_rep )

# using linearized design
svysen( ~eqincome, des_eusilc, abs_thresh=10000 )

# using replicate design:
svysen( ~eqincome, des_eusilc_rep, abs_thresh = 10000 )


# }
# NOT RUN {
# database-backed design
library(RSQLite)
library(DBI)
dbfile <- tempfile()
conn <- dbConnect( RSQLite::SQLite() , dbfile )
dbWriteTable( conn , 'eusilc' , eusilc )

dbd_eusilc <-
	svydesign(
		ids = ~rb030 ,
		strata = ~db040 ,
		weights = ~rb050 ,
		data="eusilc",
		dbname=dbfile,
		dbtype="SQLite"
	)


dbd_eusilc <- convey_prep( dbd_eusilc )

# linearized SE:
svysen(~eqincome, dbd_eusilc, abs_thresh=10000)

dbRemoveTable( conn , 'eusilc' )

dbDisconnect( conn , shutdown = TRUE )

# }
# NOT RUN {
# }

Run the code above in your browser using DataCamp Workspace