Skip to contents

Cut an aggregation structure

Source: R/cut.piar_aggregation_structure.R
cut.piar_aggregation_structure.Rd

Keep only the part of an aggregation structure above or below a certain level.

Usage

# S3 method for class 'piar_aggregation_structure'
cut(x, level, ..., na.rm = FALSE, upper = TRUE)

Arguments

x

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

level

[integer(1) > 0] A positive integer, or something that can be coerced into one, giving the level at which to cut x.

...

Not currently used.

na.rm

[logical(1)] Should missing values be removed when aggregating the weights? By default, missing values are not removed.

upper

[logical(1)] Keep only the part of x above level (the default); otherwise, return the part of x below level.

Value

A price index aggregation structure of class piar_aggregation_structure.

See also

Other aggregation structure methods: as.matrix.piar_aggregation_structure(), levels.piar_aggregation_structure(), update.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 <- aggregation_structure(
  aggregation_weights[1:3],
  weights = aggregation_weights[[4]]
)

# Turn it into
#            1
#      |-----+-----|
#      11          12
#     (4)         (4)
cut(pias, 2)
#> Aggregation structure for 2 elementary aggregates with 1 levels above the elementary aggregates 
#>   level1 level2 weight
#> 1      1     11      4
#> 2      1     12      4