R/dmai-package.R

In dmai: Divisia Monetary Aggregates Index

#' dmai: Divisia monetary aggregates index
#'
#' @description
#' The \pkg{dmai} package builds monetary aggregates from their components (currency, demand deposits, savings and
#' time deposits, ...) by the methods of index number theory. The Divisia index of Barnett (1980) weights every
#' component by its share in the expenditure on monetary services, priced by its user cost (Barnett 1978); the
#' package also gives the Fisher ideal index, a variant with simple growth rates, the simple sum and the currency
#' equivalent index, the dual user-cost price index and the Divisia second moments.
#'
#' @section Functions:
#' \describe{
#'   \item{\code{\link{dmai}()}}{the aggregate by one method (Barnett, Hancock, Fisher, simple sum, currency
#'     equivalent).}
#'   \item{\code{\link{dmai_compare}()}}{every method on the same data.}
#'   \item{\code{\link{dmai_user_cost}()}}{user costs and expenditure shares of the components.}
#'   \item{\code{\link{dmai_moments}()}}{Divisia means and variances of the growth of the components.}
#'   \item{\code{\link{dmai_interpret}()}, \code{\link{dmai_cite}()}, \code{\link{dmai_app}()}}{plain-language
#'     interpretation, references and a shiny application.}
#' }
#' The data sets \code{\link{money_sim}} (simulated monetary data) and \code{\link{cpi_ch19}} (the artificial data
#' of the Consumer Price Index Manual, used to check the index formulas) come with the package.
#'
#' @references
#' Barnett, W. A. (1978). The user cost of money. \emph{Economics Letters}, \strong{1}(2), 145--149.
#' \doi{10.1016/0165-1765(78)90051-4}
#'
#' Barnett, W. A. (1980). Economic monetary aggregates: an application of index number and aggregation theory.
#' \emph{Journal of Econometrics}, \strong{14}(1), 11--48. \doi{10.1016/0304-4076(80)90070-6}
#' @author
#' Muhammad Yaseen (\email{myaseen208@@gmail.com}) and Ahmad Nadeem (\email{Ahmed.Nadeem@@sbp.org.pk})
#' @importFrom ggplot2 .data
#' @importFrom data.table :=
#' @keywords internal
"_PACKAGE"