Aggregate elemental price indexes with a price index aggregation structure.
# S3 method for chainable_piar_index
aggregate(
x,
pias,
...,
pias2 = NULL,
na.rm = FALSE,
contrib = TRUE,
r = 1,
include_ea = TRUE
)# S3 method for direct_piar_index
aggregate(
x,
pias,
...,
pias2 = NULL,
na.rm = FALSE,
contrib = TRUE,
r = 1,
include_ea = TRUE
)
An aggregate price index that inherits from the class of x
.
A price index, usually made by elemental_index()
.
A price index aggregation structure or something that can be
coerced into one. This can be made with aggregation_structure()
.
Not currently used.
An optional secondary aggregation structure, usually with current-period weights, to make a superlative index. See details.
Should missing values be removed? By default, missing values
are not removed. Setting na.rm = TRUE
is equivalent to overall mean
imputation.
Aggregate percent-change contributions in x
(if any)?
Order of the generalized mean to aggregate index values. 0 for a
geometric index (the default for making elemental indexes), 1 for an
arithmetic index (the default for aggregating elemental indexes and
averaging indexes over subperiods), or -1 for a harmonic index (usually for
a Paasche index). Other values are possible; see
gpindex::generalized_mean()
for details. If pias2
is given then the
index is aggregated with a quadratic mean of order 2*r
.
Should indexes for the elemental aggregates be included along with the aggregated indexes? By default, all index values are returned.
The aggregate()
method loops over each time period in x
and
aggregates the elemental indexes with
gpindex::generalized_mean(r)()
for each level
of pias
;
aggregates percent-change contributions for each level of
pias
(if there are any and contrib = TRUE
);
price updates the weights in pias
with
gpindex::factor_weights(r)()
(only for
period-over-period elemental indexes).
The result is a collection of aggregated period-over-period indexes that
can be chained together to get a fixed-base index when x
are
period-over-period elemental indexes. Otherwise, when x
are fixed-base
elemental indexes, the result is a collection of aggregated fixed-base
(direct) indexes.
By default, missing elemental indexes will propagate when aggregating the
index. Missing elemental indexes can be due to both missingness of these
values in x
, and the presence of elemental aggregates in pias
that are not part of x
. Setting na.rm = TRUE
ignores missing
values, and is equivalent to parental (or overall mean) imputation. As an
aggregated price index generally cannot have missing values (for otherwise
it can't be chained over time and weights can't be price updated), any
missing values for a level of pias
are removed and recursively replaced
by the value of its immediate parent.
In most cases aggregation is done with an arithmetic mean (the default), and this is detailed in chapter 8 (pp. 190--198) of the CPI manual (2020), with analogous details in chapter 9 of the PPI manual (2004). Aggregating with a non-arithmetic mean follows the same steps, except that the elemental indexes are aggregated with a mean of a different order (e.g., harmonic for a Paasche index), and the method for price updating the weights is slightly different. Note that, because aggregation is done with a generalized mean, the resulting index is consistent-in-aggregation at each point in time.
Aggregating percent-change contributions uses the method in chapter 9 of the
CPI manual (equations 9.26 and 9.28) when aggregating with an arithmetic
mean. With a non-arithmetic mean, arithmetic weights are constructed using
gpindex::transmute_weights(r, 1)()
in order
to apply this method.
There may not be contributions for all prices relatives in an elemental
aggregate if the elemental indexes are built from several sources (as with
merge()
). In this case the contribution for
a price relative in the aggregated index will be correct, but the sum of all
contributions will not equal the change in the value of the index. This can
also happen when aggregating an already aggregated index in which missing
index values have been imputed (i.e., when na.rm = TRUE
and
contrib = FALSE
).
If two aggregation structures are given then the steps above are done for
each aggregation structure, with the aggregation for pias
done with a
generalized mean of order r
the aggregation for pias2
done with a
generalized mean of order -r
. The resulting indexes are combined with a
geometric mean to make a superlative quadratic mean of order 2*r
index.
Percent-change contributions are combined using a generalized van IJzeren
decomposition; see gpindex::nested_transmute()
for details.
Balk, B. M. (2008). Price and Quantity Index Numbers. Cambridge University Press.
ILO, IMF, UNECE, OECD, and World Bank. (2004). Producer Price Index Manual: Theory and Practice. International Monetary Fund.
IMF, ILO, OECD, Eurostat, UNECE, and World Bank. (2020). Consumer Price Index Manual: Concepts and Methods. International Monetary Fund.
von der Lippe, P. (2007). Index Theory and Price Statistics. Peter Lang.
Other index methods:
[.piar_index()
,
as.data.frame.piar_index()
,
as.ts.piar_index()
,
chain()
,
contrib()
,
head.piar_index()
,
is.na.piar_index()
,
levels.piar_index()
,
mean.piar_index
,
merge.piar_index()
,
split.piar_index()
,
stack.piar_index()
,
time.piar_index()
,
window.piar_index()
prices <- data.frame(
rel = 1:8,
period = rep(1:2, each = 4),
ea = rep(letters[1:2], 4)
)
# A two-level aggregation structure
pias <- aggregation_structure(
list(c("top", "top", "top"), c("a", "b", "c")), weights = 1:3
)
# Calculate Jevons elemental indexes
(elemental <- elemental_index(prices, rel ~ period + ea))
# Aggregate (note the imputation for elemental index 'c')
(index <- aggregate(elemental, pias, na.rm = TRUE))
# Aggregation can equivalently be done as matrix multiplication
as.matrix(pias) %*% as.matrix(chain(index[letters[1:3]]))
Run the code above in your browser using DataLab