clean_input_tabulation: Clean (and check) the inputs for 'tabulation_fit'

View source: R/clean-input.R

clean_input_tabulationR Documentation

Clean (and check) the inputs for tabulation_fit

Description

Check the validity and consistency of the input arguments of tabulation_fit.

Usage

clean_input_tabulation(
  p,
  threshold,
  average = NULL,
  bracketshare = NULL,
  topshare = NULL,
  bracketavg = NULL,
  topavg = NULL,
  invpareto = NULL,
  bottom_model = NULL,
  lower_bound = 0
)

Arguments

p

A vector of values in [0, 1].

threshold

The quantiles corresponding to p.

average

The average over the entire distribution.

bracketshare

The corresponding bracket share.

topshare

The corresponding top share.

bracketavg

The corresponding bracket average.

topavg

The corresponding top average.

invpareto

The inverted Pareto coefficient.

bottom_model

Which model to use at the bottom of the distribution? Only relevant if min(p) > 0. Either "gpd" for the generalized Pareto distribution, "hist" for histogram density, or "dirac". Default is "hist" if min(threshold) > 0, "dirac" if min(threshold) == 0 and "gpd" otherwise.

lower_bound

Lower bound of the distribution. Only relevant if min(p) > 0. Default is 0.

Author(s)

Thomas Blanchet, Juliette Fournier, Thomas Piketty


thomasblanchet/gpinter documentation built on Nov. 29, 2022, 4:32 a.m.