compute_pip_stats: Compute default PIP statistics (microdata)

In PIP-Technical-Team/wbpip: What the Package Does (One Line, Title Case)

Compute default PIP statistics (microdata)

Description

Compute poverty and distributional statistics for microdata.

Usage

compute_pip_stats(
  welfare,
  povline,
  population = NULL,
  requested_mean = NULL,
  popshare = NULL,
  default_ppp = 1,
  ppp = NULL,
  p0 = 0.5,
  distribution_type = c("micro", "group", "aggregate", "imputed")
)

Arguments

welfare	numeric: A vector of income or consumption values
povline	numeric: Poverty line in international dollars
population	numeric: A vector of population weights, optional, a vector of 1s if not specified.
requested_mean	numeric: Welfare mean in international dollars
popshare	numeric: Share of population for which the corresponding quantile is desired. Default .5 (i.e., weighted median)
default_ppp	numeric: Default purchasing power parity
ppp	numeric: PPP requested by user
p0	numeric: TO be documented
distribution_type	character: Type of distribution, either micro, group, aggregate or imputed.

Value

list

PIP-Technical-Team/wbpip documentation built on Nov. 29, 2024, 6:57 a.m.