fm_var {FuzzyPovertyR}R Documentation

Fuzzy monetary poverty estimation

Description

This function estimates the variance of the fuzzy monetary poverty index

Usage

fm_var(
  predicate,
  weight,
  fm,
  ID = NULL,
  type = "bootstrap",
  R = 100,
  M = NULL,
  stratum,
  psu,
  f = 0.01,
  verbose = FALSE,
  HCR,
  interval = c(1, 10),
  alpha = NULL,
  hh.size,
  z_min,
  z_max,
  z1,
  z2,
  b,
  z,
  breakdown = NULL,
  data = NULL
)

Arguments

predicate

A numeric vector representing the poverty predicate (i.e. income or expenditure)

weight

A numeric vector of sampling weights. if NULL simple random sampling weights will be used.

fm

the type of membership function to use

ID

A numeric or character vector of IDs. if NULL (the default) it is set as the row sequence.

type

The variance estimation method chosen. One between bootstrap (default) or jackknife.

R

The number of bootstrap replicates. Default is 500.

M

The size of bootstrap samples. Default is nrow(data).

stratum

The vector identifying the stratum (if 'jackknife' is chosen as variance estimation technique).

psu

The vector identifying the psu (if 'jackknife' is chosen as variance estimation technique).

f

The finite population correction fraction (if 'jackknife' is chosen as variance estimation technique).

verbose

Logical. whether to print the proceeding of the variance estimation procedure.

HCR

If fm="verma" or fm="verma1999" or fm="TFR" . The value of the head count ratio.

interval

If fm="verma" or fm="verma1999" or fm="TFR". A numeric vector of length two to look for the value of alpha (if not supplied).

alpha

If fm="verma" or fm="verma1999" or fm="TFR". The value of the exponent in equation $E(mu)^(alpha-1) = HCR$. If NULL it is calculated so that it equates the expectation of the membership function to HCR

hh.size

If fm="ZBM". A numeric vector of household size.

z_min

A parameter of the membership function if fm="belhadj2011"

z_max

A parameter of the membership function if fm="belhadj2011"

z1

A parameter of the membership function if fm="belhadj2015" or fm="cerioli"

z2

A parameter of the membership function if fm="belhadj2015" or fm="cerioli"

b

A parameter of the membership function if fm="belhadj2015". The shape parameter (if b=1 the mf is linear between z1 and z2)

z

A parameter of the membership function if fm="chakravarty".

breakdown

A factor of sub-domains to calculate estimates for (using the same alpha). If numeric will be coerced to a factor.

data

an optional data frame containing the variables to be used.

Value

An object of class FuzzyMonetary containing the estimate of variance with the method selected. if breakdown is not NULL, the variance is estimated for each sub-domain.

Examples

data(eusilc)
HCR <- 0.14
hh.size <- rep(1, 1000)
fm_var(predicate = eusilc$eq_income, weight = eusilc$DB090,
fm = "verma", breakdown = eusilc$db040, type = "bootstrap", HCR = .14, alpha = 9)


[Package FuzzyPovertyR version 2.0.1 Index]