STATISTICS command
Concept Information
Calculates statistics for one or more numeric or datetime fields in an Analytics table.
Syntax
STATISTICS {<ON> field_name <...n>|<ON> ALL <EXCLUDE field_name <...n>>} <STD> <MODMEDQ> <NUMBER n> <TO {SCREEN|filename|PRINT}> <IF test> <WHILE test> <FIRST range|NEXT range> <APPEND>
Parameters
Name | Description |
---|---|
ON field_name <...n> | ON ALL |
Specify one or more numeric or datetime fields to generate statistics for, or specify ON ALL to generate statistics for all numeric and datetime fields in the Analytics table. |
EXCLUDE field_name optional |
Only valid when generating statistics using ON ALL. The field or fields to exclude from the command. EXCLUDE allows you to fine-tune ON ALL, by excluding the specified fields. EXCLUDE must immediately follow ON ALL. For example: ON ALL EXCLUDE field_1 field_2 |
STD optional |
Calculates the standard deviation of the fields specified, in addition to the other statistics. |
MODMEDQ optional |
Calculates the mode, median, first quartile, and third quartile values of the fields specified, in addition to the other statistics. |
NUMBER n optional |
The number of high and low values to retain during processing. The default value is 5. |
TO SCREEN | filename | PRINT optional |
The location to send the results of the command to:
|
IF test optional |
A conditional expression that must be true in order to process each record. The command is executed on only those records that satisfy the condition. Note The IF parameter is evaluated against only the records remaining in a table after any scope parameters have been applied (WHILE, FIRST, NEXT). |
WHILE test optional |
A conditional expression that must be true in order to process each record. The command is executed until the condition evaluates as false, or the end of the table is reached. Note If you use WHILE in conjunction with FIRST or NEXT, record processing stops as soon as one limit is reached. |
FIRST range | NEXT range optional |
The number of records to process:
Use range to specify the number of records to process. If you omit FIRST and NEXT, all records are processed by default. |
APPEND optional |
Appends the command output to the end of an existing file instead of overwriting it. Note You must ensure that the structure of the command output and the existing file are identical:
Analytics appends output to an existing file regardless of its structure. If the structure of the output and the existing file do not match, jumbled, missing, or inaccurate data can result. |
Analytics output variables
Note
If you generate statistics for more than one field in a table, the system-generated output variables contain values for the first listed field only.
Name | Contains |
---|---|
ABSn |
The absolute value calculated by the command. |
AVERAGEn |
The mean value calculated by the command. |
COUNTn |
The record count calculated by the command.
|
HIGHn |
The 5th highest value identified by the command. The 5th highest is the default setting. The setting can be changed using the NUMBER parameter. For example, NUMBER 3 specifies that the 3rd highest value is stored. Note When Analytics identifies the highest value, duplicate values are not factored out. For example, if values in descending order are 100, 100, 99, 98, the 3rd highest value is 99, not 98. |
LOWn |
The 5th lowest value identified by the command. The 5th lowest is the default setting. The setting can be changed using the NUMBER parameter. For example, NUMBER 3 specifies that the 3rd lowest value is stored. Note When Analytics identifies the lowest value, duplicate values are not factored out. For example, if values in ascending order are 1, 1, 2, 3, the 3rd lowest value is 2, not 3. |
MAXn |
The maximum value identified by the command. |
MEDIANn |
The median value identified by the command. |
MINn | The minimum value identified by the command. |
MODEn | The most frequently occurring value identified by the command. |
Q25n | The first quartile value (lower quartile value) calculated by the command. |
Q75n | The third quartile value (upper quartile value) calculated by the command. |
RANGEn | The difference between the maximum and minimum values calculated by the command. |
STDDEVn | The standard deviation value calculated by the command. |
TOTALn |
The total value calculated by the command. The value of n is 1 unless the TOTAL command is inside a GROUP command, in which case the value of n corresponds to the line number of the TOTAL command in the GROUP command. For more information, see GROUP command. |
Examples
Generating conditional statistics
You generate statistics for the Quantity field in records where the product class ID is 01:
STATISTICS ON Quantity IF ProdCls = "01"