mbennet: Calculating the multilateral Bennet price and quantity...

View source: R/f_multilateral_indicators.R

mbennetR Documentation

Calculating the multilateral Bennet price and quantity indicators

Description

This function returns the multilateral Bennet price and quantity indicators and optionally also the price and quantity contributions of individual products.

Usage

mbennet(
  data,
  start,
  end,
  wstart = start,
  matched = FALSE,
  window = 13,
  interval = FALSE,
  contributions = FALSE,
  prec = 2
)

Arguments

data

The user's data frame with information about sold products. It must contain columns: time (as Date in format: year-month-day,e.g. '2020-12-01'), prices (as positive numeric) and prodID (as numeric, factor or character). A column quantities (as positive numeric) is also needed because this function uses unit values as monthly prices.

start

The base period (as character) limited to the year and month, e.g. "2020-03".

end

The research period (as character) limited to the year and month, e.g. "2020-04".

wstart

The first period of the time window (as character) limited to the year and month, e.g. "2019-12".

matched

A logical parameter indicating whether the matched sample approach is to be used (if yes, the parameter has the value TRUE).

window

The length of the time window (as positive integer: typically multilateral methods are based on the 13-month time window).

interval

A logical parameter indicating whether calculations are to be made for the whole time interval (TRUE) or no (FALSE).

contributions

A logical parameter indicating whether contributions of individual products are to be displayed. If it is TRUE, then contributions are calculated for the the base period start and the current period end.

prec

A numeric vector indicating precision, i.e. the number of decimal places for presenting results.

Value

This function returns the multilateral Bennet price and quantity indicators and optionally also the price and quantity contributions of individual products.

References

Bennet, T. L., (1920). The Theory of Measurement of Changes in Cost of Living. Journal of the Royal Statistical Society, 83, 455-462.

Fox, K.J., (2006). A Method for Transitive and Additive Multilateral Comparisons: A Transitive Bennet Indicator. Journal of Economics, 87(1), 73-87.

Examples

mbennet(milk, "2018-12", "2019-12", matched=TRUE, contributions=TRUE)
mbennet(coffee, start="2018-12", end="2019-03", interval=TRUE)

PriceIndices documentation built on July 9, 2023, 6:20 p.m.