get_lorenz: Lorenz curve

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

Lorenz curve

Description

Calculate points on the Lorenz curve. TO BE DOCUMENTED.

Usage

get_lorenz(
  .data,
  welfare,
  weight,
  distribution_type = c("micro", "group", "aggregate", "imputed"),
  nbins = NULL
)

Arguments

.data	Household survey data frame with at least a welfare variable.
welfare	numeric: A vector of income or consumption values.
weight	numeric: A vector of weights. Default is a vector of ones, rep(1, length(welfare)).
distribution_type	character: Type of distribution, either micro, group, aggregate or imputed.
nbins	numeric: number of points on the Lorenz curve. if NULL the returning Lorenz curve would be the length of the original welfare vector minus the number of NAs of different observations in welfare and weight. Default is 100 for length(welfare) > 1000 and 20 otherwise.

Value

data.frame

Examples

data("md_ABC_2000_income")
df <- md_ABC_2000_income
lorenz <- get_lorenz(df, welfare, weight)
str(lorenz)

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