update.piar_aggregation_structure {piar}R Documentation

Update an aggregation structure

Description

Price update the weights in a price index aggregation structure.

Usage

## S3 method for class 'piar_aggregation_structure'
update(object, index, period = end(index), ..., r = NULL)

Arguments

object

A price index aggregation structure, as made by aggregation_structure().

index

A price index, or something that can be coerced into one. Usually an aggregate price index as made by aggregate().

period

The time period used to price update the weights. The default uses the last period in index.

...

Not currently used.

r

Order of the generalized mean to update the weights. The default uses the order used to aggregate index if it's an aggregate index; otherwise, the default is 1 for an arithmetic index.

Value

A copy of object with price-updated weights using the index values in index.

See Also

aggregate() to make an aggregated price index.

Other aggregation structure methods: as.matrix.piar_aggregation_structure(), levels.piar_aggregation_structure(), weights.piar_aggregation_structure()

Examples

# A simple aggregation structure
#            1
#      |-----+-----|
#      11          12
#  |---+---|       |
#  111     112     121
#  (1)     (3)     (4)

aggregation_weights <- data.frame(
  level1 = c("1", "1", "1"),
  level2 = c("11", "11", "12"),
  ea     = c("111", "112", "121"),
  weight = c(1, 3, 4)
)

pias <- as_aggregation_structure(aggregation_weights)

index <- as_index(
  matrix(1:9, 3, dimnames = list(c("111", "112", "121"), NULL))
)

weights(pias, ea_only = FALSE)

weights(update(pias, index), ea_only = FALSE)


[Package piar version 0.7.0 Index]