LAG returns a value from a period in the past. 

You could use LAG to calculate how this month's earnings compare to last year's monthly earnings. 

Syntax

LAG(Value to offset, Offset amount, Substitute value [, Non-positive behavior])

Arguments

ArgumentData TypeDescription
Value to offsetNumber, Boolean, date,
time period, list, or text
Value to replace with a value from a different time period.
Offset amountNumber

Number of periods in the past from which to retrieve a value.

Positive values refer to past periods, negative to future ones, and zero the current period.

Substitute valueSame as Value to offset

Value to apply if theOffset amount specifies a period outside of the model's time range.

Also used for non-positive offsets if you use the SEMISTRICT or STRICT keywords for the Non-positive behavior argument.

Non-positive behavior (optionalKeywordDetermines how the LAG function uses the Substitute value argument.

The LAG function returns a result of the same data type as the Value to offset argument.

Non-positive behavior keywords

KeywordDescription
NONSTRICT

The default keyword if you omit the Non-positive behavior argument.

Returns the Value to offset if the Offset amount is positive, negative, or zero.

SEMISTRICTReturns the Value to offset if the Offset amount is positive or zero. 
STRICTReturns the Value to offset if the Offset amount is positive.

Syntax example

LAG(Value to offset, 2, 0)


JanFebMarAprilMayJune
Value to
offset

  3,000

    1,000

 2,000

 7,000

2,500

3,000
LAG 1        0         0 3,000 1,0002,0007,000

In this example, the LAG 1 line item contains the formula above. This means it returns the value from two periods before.

Since for Jan and Feb, two periods before the cells are outside of the module’s time range, the formula returns the Substitute value of 0. The function does not contain the Non-positive behavior argument, so the default behavior is NONSTRICT.

Additional information

If the period LAG specifies is outside of the module's time range, LAG returns the value of the substitute value argument.

Calculation engine functionality differences

In Polaris, any number used for the Offset amount argument is rounded to the nearest integer. A value of NaN (Not a Number) for the Offset amount argument returns the Substitute value argument.

In the Classic Engine, any number used for the Offset amount argument is rounded towards zero. A value of NaN is equivalent to 0.

Related Anaplan functions

Examples

General example

In this example, the Lag by two periods line item contains a formula that returns the Value to offset from two periods prior.


JanFebMarAprilMayJune
Value to
offset
3,0001,0002,0007,0002,5003,000
Substitute
value
1016125

Lag by two periods

LAG(Value to offset, 2, Substitute value)

1013,0001,0002,0007,000

When the Offset amount specifies a period that falls outside the time range, LAG returns the Substitute value amount, as shown in Jan and Feb columns.

The formula does not contain the Non-positive behavior argument, so it uses the default behavior, NONSTRICT.

Example with a constant offset

In this example, the LAG with constant offset line item contains the formula above. This means it returns line item from two periods before each cell.

If the Substitute value amount falls outside the model time range, the value from the Value to offset row in the current period is used, as shown in Jan and Feb columns. The formula does not contain the Non-positive behavior argument, so it uses the default behavior, NONSTRICT.


JanFebMarAprilMayJune
Value to
offset
3,0001,0002,0007,0002,5003,000
Substitute
value
1016125

LAG with constant offset

LAG(Value to offset, 2, Substitute value)

1013,0001,0002,0007,000

Example of different non-positive behavior keywords

In this example, you can see how the different keywords for the Non-positive behavior argument change the results.


JanFebMarchAprilMayJune
Value to
offset
123456
Offset
amount
0-10101
Substitute
value
100200300400500600

Semistrict behavior

LAG(Value to offset, Offset amount, Substitute value, SEMISTRICT)

12003355

Strict behavior

LAG(Value to offset, Offset amount, Substitute value, STRICT)

10020030035005

Nonstrict behavior

LAG(Value to offset, Offset amount, Substitute value, NONSTRICT)

133355

Disclaimer

We may update our documentation occasionally, but will only do so in a way that does not negatively affect the features and functionality of the Anaplan service.