Stats Supplier

Overview

Provides access to calculated statistics on a set of data.

Statistics are generated by other macros or suppliers, such as the grouping-reporter and the Stats On Supplier.

Details

Name:

Stats Supplier

Prefix:

stats

(optional)

Supported Content:

Stats Objects

Provided By:

Reporting, from version 3.2.0

Supported Keys

The following are the list of keys which this supplier will return a value for.

Key

Content Types

Return Type

Description

sum

Stats

The sum of all number values in the analyzed set.

empty count

Stats

The number of empty items in the analysed set.

value count

Stats

The number of non-empty items in the analyzed set.

item count

Stats

The total number of items in the analyzed set.

value average

Stats

The average of all numbers in the set compared to the number of non-blank items in the analysed set.

Non-numeric objects are included in the count used to calculate the average, even if they aren't numbers.

item average

Stats

The average of all number values in the set compared to the total number of items, including blank values.

min value

Stats

Anything

The minimum value in the set. This will work with numbers, dates, strings and anything else that is natively comparable. However, the set contains objects of different types, there will probably be no value here.

max value

Stats

Anything

The maximum value in the set. This will work with numbers, dates, strings and anything else that is natively comparable. However, the set contains objects of different types, there will probably be no value here.

min item

Stats

Anything

The original item from the analysed set that contained the minimum value.

max item

Stats

Anything

The original item from the analysed set that contained the maximum value.

Examples


See the grouping-reporter and Stats On Supplier for examples of using this supplier.