summary.piar_index {piar}

Summarize a price index

Description

Summarize an index as a matrix of index values (i.e., the five-number summary for each period). If there are percent-change contributions, then these are also summarized as a matrix.

Usage

## S3 method for class 'piar_index'
summary(object, ...)

Arguments

object

A price index, as made by, e.g., elemental_index().

...

Additional arguments passed to summary.matrix().

Value

A list of five-number summaries.

Note

This function is still experimental and may change in the future.

Examples

prices <- data.frame(
  rel = 1:8,
  period = rep(1:2, each = 4),
  ea = rep(letters[1:2], 4),
  contrib = TRUE
)

elemental <- with(prices, elemental_index(rel, period, ea))

summary(elemental)