diff --git a/man/pipgd_gini.Rd b/man/pipgd_gini.Rd index 90d282e..39a3d8d 100644 --- a/man/pipgd_gini.Rd +++ b/man/pipgd_gini.Rd @@ -10,7 +10,8 @@ pipgd_gini( welfare = NULL, weight = NULL, complete = getOption("pipster.return_complete"), - lorenz = NULL + lorenz = NULL, + ... ) } \arguments{ @@ -27,6 +28,8 @@ previously used \code{get_gd} functions. Default is \code{FALSE}} \item{lorenz}{character or NULL. Lorenz curve selected. It could be "lq" for Lorenz Quadratic or "lb" for Lorenz Beta} + +\item{...}{additional arguments for \link{pipgd_select_lorenz}} } \value{ Returns a nested list containing distribution statistics: diff --git a/man/pipgd_mld.Rd b/man/pipgd_mld.Rd index 7842654..1b12cc4 100644 --- a/man/pipgd_mld.Rd +++ b/man/pipgd_mld.Rd @@ -10,7 +10,8 @@ pipgd_mld( welfare = NULL, weight = NULL, complete = getOption("pipster.return_complete"), - lorenz = NULL + lorenz = NULL, + ... ) } \arguments{ @@ -27,6 +28,8 @@ previously used \code{get_gd} functions. Default is \code{FALSE}} \item{lorenz}{character or NULL. Lorenz curve selected. It could be "lq" for Lorenz Quadratic or "lb" for Lorenz Beta} + +\item{...}{additional arguments for \link{pipgd_select_lorenz}} } \value{ Returns a nested list containing distribution statistics: diff --git a/man/pipgd_params.Rd b/man/pipgd_params.Rd index 0674d8e..e9bc217 100644 --- a/man/pipgd_params.Rd +++ b/man/pipgd_params.Rd @@ -4,7 +4,7 @@ \alias{pipgd_params} \title{Get Group Data Parameters} \usage{ -pipgd_params(welfare, weight, mean = NULL, population = NULL) +pipgd_params(welfare, weight, mean = 1, population = NULL) } \arguments{ \item{welfare}{numeric vector of cumulative share of welfare (income/consumption)} diff --git a/man/pipgd_polarization.Rd b/man/pipgd_polarization.Rd index 3b845a8..2fb2234 100644 --- a/man/pipgd_polarization.Rd +++ b/man/pipgd_polarization.Rd @@ -5,6 +5,7 @@ \title{Compute polarization index} \usage{ pipgd_polarization( + pipster_object = NULL, params = NULL, welfare = NULL, weight = NULL, @@ -15,6 +16,8 @@ pipgd_polarization( ) } \arguments{ +\item{pipster_object}{pipster object created using \link{create_pipster_object}} + \item{params}{list of parameters from \code{pipgd_validate_lorenz()}} \item{welfare}{numeric vector of cumulative share of welfare (income/consumption)} diff --git a/man/pipgd_quantile.Rd b/man/pipgd_quantile.Rd index 69f60de..7d8f2fa 100644 --- a/man/pipgd_quantile.Rd +++ b/man/pipgd_quantile.Rd @@ -11,9 +11,9 @@ pipgd_quantile( weight = NULL, n = 10, popshare = seq(from = 1/n, to = 1, by = 1/n), - mean = 1, complete = getOption("pipster.return_complete"), - lorenz = NULL + lorenz = NULL, + ... ) } \arguments{ @@ -29,13 +29,13 @@ pipgd_quantile( \item{popshare}{numeric: vector of share of population. Default is \code{seq(from = 1/n, to = 1, by = 1/n)}} -\item{mean}{numeric scalar of distribution mean. Default is 1} - \item{complete}{logical: If TRUE, returns a list a cumulative returns from previously used \code{get_gd} functions. Default is \code{FALSE}} \item{lorenz}{character or NULL. Lorenz curve selected. It could be "lq" for Lorenz Quadratic or "lb" for Lorenz Beta} + +\item{...}{additional arguments for \link{pipgd_select_lorenz}} } \value{ Returns a nested list containing distribution statistics: diff --git a/man/pipgd_quantile_welfare_share.Rd b/man/pipgd_quantile_welfare_share.Rd index 228279f..96036d3 100644 --- a/man/pipgd_quantile_welfare_share.Rd +++ b/man/pipgd_quantile_welfare_share.Rd @@ -12,7 +12,8 @@ pipgd_quantile_welfare_share( complete = getOption("pipster.return_complete"), lorenz = NULL, n = 10, - popshare = seq(from = 1/n, to = 1, by = 1/n) + popshare = seq(from = 1/n, to = 1, by = 1/n), + ... ) } \arguments{ @@ -33,6 +34,8 @@ Lorenz Quadratic or "lb" for Lorenz Beta} \item{n}{numeric scalar for the number of quantiles to be used in \code{popshare}} \item{popshare}{numeric: vector of share of population. Default is \code{seq(from = 1/n, to = 1, by = 1/n)}} + +\item{...}{additional arguments for \link{pipgd_select_lorenz}} } \value{ Returns a nested list containing distribution statistics: diff --git a/man/pipgd_welfare_share_at.Rd b/man/pipgd_welfare_share_at.Rd index 97db62f..7f6264f 100644 --- a/man/pipgd_welfare_share_at.Rd +++ b/man/pipgd_welfare_share_at.Rd @@ -12,7 +12,8 @@ pipgd_welfare_share_at( complete = getOption("pipster.return_complete"), lorenz = NULL, n = 10, - popshare = seq(from = 1/n, to = 1, by = 1/n) + popshare = seq(from = 1/n, to = 1, by = 1/n), + ... ) } \arguments{ @@ -33,6 +34,8 @@ Lorenz Quadratic or "lb" for Lorenz Beta} \item{n}{numeric scalar for the number of quantiles to be used in \code{popshare}} \item{popshare}{numeric: vector of share of population. Default is \code{seq(from = 1/n, to = 1, by = 1/n)}} + +\item{...}{additional arguments for \link{pipgd_select_lorenz}} } \value{ Returns a nested list containing distribution statistics: diff --git a/man/validate_params.Rd b/man/validate_params.Rd index a1553b8..ab1e579 100644 --- a/man/validate_params.Rd +++ b/man/validate_params.Rd @@ -4,7 +4,16 @@ \alias{validate_params} \title{Validate group data parameters} \usage{ -validate_params(pipster_object, welfare, weight, params) +validate_params( + pipster_object, + welfare, + weight, + params, + mean = 1, + times_mean = 1, + popshare = NULL, + povline = ifelse(is.null(popshare), mean * times_mean, NA_real_) +) } \arguments{ \item{pipster_object}{pipster object created using \link{create_pipster_object}} @@ -14,6 +23,8 @@ validate_params(pipster_object, welfare, weight, params) \item{weight}{numeric vector of cumulative share of the population} \item{params}{list of parameters from \code{pipgd_validate_lorenz()}} + +\item{popshare}{numeric: vector of share of population. Default is \code{seq(from = 1/n, to = 1, by = 1/n)}} } \value{ list: \code{params} to be used in gd functions