Skip to content

TSTool / Command / SetIgnoreLEZero

Overview

The SetIgnoreLEZero command sets the global property that indicates whether the computation of historical averages for time series should ignore values less than or equal to zero. By default, all values (other than the missing data placeholder) are used to compute averages. This command is useful when it is appropriate to ignore zero and negative values in averages, for example in cases where zero is assigned as an observation but may influence averages inappropriately.

Commands that are concerned with this issue also typically provide a parameter. Setting a global default with this command can make it more difficult to understand processing.

Command Editor

The command is available in the following TSTool menu:

  • Commands / Fill Time Series Missing Data

The following dialog is used to edit the command and illustrates the syntax of the command.

SetIgnoreLEZero command editor

SetIgnoreLEZero Command Editor (see full-size image)

Command Syntax

The command syntax is as follows:

SetIgnoreLEZero(Parameter="Value",...)

Command Parameters

Parameter            Description Default                           
IgnoreLEZero Indicates whether the computation of historical averages should ignore values less than or equal to zero, True or False. If this command is not used, the default is False.

Examples

See the automated tests.

Troubleshooting

See the main TSTool Troubleshooting documentation.

See Also