Estimate poverty gap (FGT1) — pipgd_pov_gap

This function is not vectorized. Use pipgd_pov_gap instead

Usage

pipgd_pov_gap_nv(
  params = NULL,
  welfare = NULL,
  weight = NULL,
  mean = 1,
  times_mean = 1,
  popshare = NULL,
  povline = ifelse(is.null(popshare), mean * times_mean, NA_real_),
  lorenz = NULL,
  complete = getOption("pipster.return_complete")
)

Arguments

params: list of parameters from pipgd_validate_lorenz()
welfare: numeric vector of cumulative share of welfare (income/consumption)
weight: numeric vector of cumulative share of the population
mean: numeric scalar of distribution mean. Default is 1
times_mean: numeric factor that multiplies the mean to create a relative poverty line. Default is 1
popshare: numeric: range (0,1). Share of population. Provide share of population instead of poverty line
povline: numeric: value of poverty line. Default is the mean value
lorenz: character or NULL. Lorenz curve selected. It could be "lq" for Lorenz Quadratic or "lb" for Lorenz Beta
complete: logical: If TRUE, returns a list a cumulative returns from previously used get_gd functions. Default is FALSE

Value

numeric poverty gap value