IndexNumR-package: IndexNumR: A package for computing index numbers

In IndexNumR: Index Number Calculation

IndexNumR: A package for computing index numbers

Description

IndexNumR is a package for computing bilateral and multilateral index numbers. The package has been designed with performance in mind, to enable computing index numbers on large datasets within a reasonable timeframe. It also aims to make a large number of index number methods available, along with access to datasets to enable research and experimentation.

Author

Graham White

Notes

I'd like to thank all those that have commented on, or tested the code so that it could be improved. In particular, I'd like to thank Professor Kevin Fox at the University of New South Wales for his support and input.

Some function parameters can have a considerable impact on the outputs, so it is recommended that the user read the documentation for these functions carefully.

Vignettes

There is very detailed information about the functions in the package vignette, which can be accessed with,

browseVignettes("IndexNumR").

Bilateral index functions

Compute bilateral indexes

• priceIndex

• quantityIndex

Similarity chain linking

Compute dissimilarity measures or chain links.

• relativeDissimilarity

• mixScaleDissimilarity

• maximumSimilarityLinks

Multilateral index functions

Compute multilateral indexes

• GEKSIndex

• GKIndex

• WTPDIndex

Other index number functions

• groupIndexes

• yearOverYearIndexes

Data preparation functions

Perform various operations on the data before using other functions, such as index number functions.

• unitValues

• imputeCarryPrices

• imputeQuantities

Data exploration functions

Learn more about the characteristics of your dataset.

• evaluateMatched

• values

Sample data

IndexNumR has one sample dataset,

• CES_sigma_2,

and a function for generating small datasets,

• CESData,

and a function for accessing the Dominicks Finer Foods scanner data,

• dominicksData.

Differences approach to index numbers

These functions are referred to as indicators, to distinguish them from the bilateral and multilateral index functions which use the ratio approach.

• priceIndicator

• quantityIndicator

Time index functions

Index functions in IndexNumR generally need a time period variable. These functions will compute the required time period variable, depending on the frequency required.

• weekIndex

• monthIndex

• quarterIndex

• yearIndex

See Also

Useful links:

• https://github.com/grahamjwhite/IndexNumR

IndexNumR documentation built on Nov. 11, 2023, 1:07 a.m.