Stats On Supplier

Overview

Performs basic statistical analysis on values in a Collection of items.

This supplier takes a quoted keychain which will usually point to a number, date or other 'comparable' value, and processes each item, resulting in a Stats report that lets you access the results, such as the sum, average, min, max, etc. Also see the grouping-reporter for for more complex options.

Details

Name:

Stats On Supplier

Prefix:

stats-on

(required)

Supported Content:

Anything, but Collections will be the most effective.

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

"prefix:key > prefix:key"

Anything

The quoted keychain to perform analysis on. This should point to a single value, typically a number, date or other 'comparable' value.

Examples


Average Versions Per Page

This will output the average number of versions for each child page of parent page.

Instructions

  1. Create a Report Info macro
  2. Insert the following for the Key parameter:

    page:children > stats-on:"page:version history > collection:size" > stats:value average
  3. Insert a parent page for the Source parameter. In our example, we used the List of Suppliers page.

Result

List of Suppliers: 5.190476190476191

Things to Note

  1. We start with a collection ('page:children').
  2. "page:version history > collection:size" is in quotes. This is so that that 'stats' keychain gets passed into the 'stats-on' supplier, and doesn't become part of the main keychain.
  3. After the 'stats-on' section, we continue to the Stats Supplier to retrieve the value we're after, in this case 'value average', which is the average of all non-blank values.