INTINDEX Function

Arguments

interval

specifies a character constant, a variable, or an expression that contains an interval name such as WEEK, MONTH, or QTR. Interval can appear in uppercase or lowercase. The possible values of interval are listed in the Intervals Used with Date and Time Functions table in SAS Language Reference: Concepts.

Tip:	If interval is a character constant, then enclose the value in quotation marks.
Requirement:	Valid values for interval depend on whether date-value is a date, time, or datetime value. For more information, see Commonly Used Time Intervals.

Multipliers and shift indexes can be used with the basic interval names to construct more complex interval specifications. The general form of an interval name is as follows:

interval<multiple.shift-index>

The three parts of the interval name are as follows:

interval

specifies the name of the basic interval type. For example, YEAR specifies yearly intervals.

multiple

specifies an optional multiplier that sets the interval equal to a multiple of the period of the basic interval type. For example, the interval YEAR2 consists of two-year, or biennial, periods.

See:	Incrementing Dates and Times by Using Multipliers and by Shifting Intervals for more information.

shift-index

specifies an optional shift index that shifts the interval to start at a specified subperiod starting point. For example, YEAR.3 specifies yearly periods shifted to start on the first of March of each calendar year and to end in February of the following year.

Restriction:	The shift index cannot be greater than the number of subperiods in the whole interval. For example, you could use YEAR2.24, but YEAR2.25 would be an error because there is no 25th month in a two-year interval.
Restriction:	If the default shift period is the same as the interval type, then only multiperiod intervals can be shifted with the optional shift index. For example, because MONTH type intervals shift by MONTH subperiods by default, monthly intervals cannot be shifted with the shift index. However, bimonthly intervals can be shifted with the shift index, because there are two MONTH intervals in each MONTH2 interval. For example, the interval name MONTH2.2 specifies bimonthly periods starting on the first day of even-numbered months.
See:	Incrementing Dates and Times by Using Multipliers and by Shifting Intervals for more information.

date-value

specifies a date, time, or datetime value that represents a time period of the given interval.

INTINDEX Function Intervals

The INTINDEX function returns the seasonal index when you supply an interval and an appropriate date, time, or datetime value. The seasonal index is a number that represents the position of the date, time, or datetime value in the seasonal cycle of the specified interval. For example, intindex('month', '01DEC2000'd); returns a value of 12 because there are 12 months in a yearly cycle and December is the 12th month of the year. In the following examples, INTINDEX returns the same value because both statements have values that occur in the first quarter of the year 2000: intindex('qtr', '01JAN2000'd); and intindex('qtr', '31MAR2000'd); . The statement intindex('day', '01DEC2000'd); returns a value of 6 because daily data is weekly periodic and December 1, 2000, is a Friday, the sixth day of the week.

How Interval and Date-Time-Value Are Related

To correctly identify the seasonal index, the interval should agree with the date, time, or datetime value. For example, intindex('month', '01DEC2000'd); returns a value of 12 because there are 12 months in a yearly interval and December is the 12th month of the year. The MONTH interval requires a SAS date value. In the following example, intindex('day', '01DEC2000'd); returns a value of 6 because there are seven days in a weekly interval and December 1, 2000, is a Friday, the sixth day of the week. The DAY interval requires a SAS date value.

The example intindex('qtr', '01JAN2000:00:00:00'dt); results in an error because the QTR interval expects the date to be a SAS date value rather than a datetime value. The example intindex('dtmonth', '01DEC2000:00:00:00'dt); returns a value of 12. The DTMONTH interval requires a datetime value.

For more information about working with date and time intervals, see Date and Time Intervals.

Retail Calendar Intervals

The INTINDEX function can also be used with calendar intervals from the retail industry. These intervals are ISO 8601 compliant. For more information, see Retail Calendar Intervals: ISO 8601 Compliant in SAS Language Reference: Concepts.

The INTINDEX function returns the seasonal index whereas the INTCINDEX function returns the cycle index.

In the example index = intindex('day', '04APR2005'd); , the INTINDEX function returns the day of the week. In the example cycle_index = intcindex('day', '04APR2005'd); , the INTCINDEX function returns the week of the year.

In the example index = intindex('minute','01Sep78:00:00:00'dt); , the INTINDEX function returns the minute of the hour. In the example cycle_index = intcindex('minute','01Sep78:00:00:00'dt); , the INTCINDEX function returns the hour of the day.

In the example intseas('interval'); , INTSEAS returns the maximum number that could be returned by intindex('interval', date); .

The following SAS statements produce these results:

interval1 = intindex('qtr', '14AUG2005'd);
put interval1;

3

interval2 = intindex('dtqtr','23DEC2005:15:09:19'dt);
put interval2;

4

interval3 = intindex('hour', '09:05:15't);
put interval3;

10

interval4 = intindex('month', '26FEB2005'd);
put interval4;

2

interval5 = intindex('dtmonth', '28MAY2005:05:15:00'dt);
put interval5;

5

interval6 = intindex('week', '09SEP2005'd);
put interval6;

36

interval7 = intindex('tenday', '16APR2005'd);
put interval7;

11

Copyright © 2011 by SAS Institute Inc., Cary, NC, USA. All rights reserved.