WMAXn returns the weekly maximum of a specified variable, Cx, where the week is specified by n, and the value is stored on the last day of the defined week.
SYNTAX:
WMAXn(Cx, optional Time Increment)
where :
n specifies the Week Definition, which determines the begining and end of the week.
Cx is a conditional variable x
Time Increment Optional - specifies the source variables (Cx) Frequency when the Source Variable (CX) and target variable's (i.e. the variable being calculated) frequencies do not match.
NOTES:
The variable being evaluated must be specified as a Conditional Variable (use "C" instead of "V")
The result is stored based on target variables frequency:
EXAMPLE 1: Return the Weekly maximum value from a variable
Source variable (70) is set to Daily and Target variable (153) is also set to Daily. Because both the Source and Target variables are the same (Daily), the time increment BYDAY will be used.
V153 = WMAX7(C70)
Variable 153 is the weekly maximum of variable 70. The week is defined as Sunday to Saturday; therefore, the result will be stored each Saturday (last day of the defined week):
EXAMPLE 2: Return the Weekly maximum value from an Hourly variable into a Daily Calculation.
Source variable (70) is set to Hourly and Target variable (153) is set to Daily.
V70 - Is a hourly parameter
V153 - Is a daily calculation
V153 = WMAX7(V70,BYHOUR)
Note: You MUST specify the Time Increment (BYHOUR) that matches the source variables frequency (IE the source variable V70 is Hourly, therefore we specify BYHOUR) in order for the function to return the correct value.
See: Working with Daily Detail Variables in Calculations.