Skip to content

Commit

Permalink
docs: update aggregation
Browse files Browse the repository at this point in the history
  • Loading branch information
narekhovhannisyan committed Oct 4, 2024
1 parent a881785 commit 13a3d68
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/major-concepts/aggregation.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ There are two fields: `metrics` and `type`.

`metrics` is an array of metrics that you want to aggregate. You can provide any value here, but they must match a key that exists in your output data (i.e. if you tell IF to aggregate `carbon` but `carbon` is not in your outputs you will receive an error message and aggregation will fail). You can provide any number of metrics. In the example above, the aggregation feature will operate on the `carbon` and `energy` values.

`type` determines which kind of aggregation you want to perform. The choices are `horizontal` (time-series aggregation only), `vertical` (tree aggregation only) or `both` (both kinds of aggregation will be performed). In the example above, both types of aggregation will be performed over the two selected metrics.
`type` determines which kind of aggregation you want to perform. The choices are `time` (previously `horizontal`: time-series aggregation only), `component` (previously `vertical`: tree aggregation only) or `both` (both kinds of aggregation will be performed). In the example above, both types of aggregation will be performed over the two selected metrics.

## Aggregation methods

Expand Down

0 comments on commit 13a3d68

Please sign in to comment.