Time Index Frequencies and Periods

Share:

Description

Return the tif code of an object, the name associated with a tif code, the period number of a time index, or the first .

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
tif(x, ...)
## S3 method for class 'ti'
tif(x, ...)
## S3 method for class 'tis'
tif(x, ...)
## S3 method for class 'ts'
tif(x, ...)
## Default S3 method:
tif(x, freq = NULL, ...)
tifName(s)
## Default S3 method:
tifName(s)
## S3 method for class 'ti'
tifName(s)
## S3 method for class 'tis'
tifName(s)
period(z)
basePeriod(x)

Arguments

x

a ti or tis object, or a string giving a tif name.

freq

numeric. If x is missing, return the tif for this frequency, otherwise ignore.

...

ignored

s

a ti or tis object, or a tif code.

z

a ti object.

Details

The tifList object associates tifNames with tif codes. Most functions that call for tif argument can take either a tif code or a tif name.

Both function are generic function with methods for ti and tis objects, as well as a default method. tif also has a method for ts objects.

Value

tif returns the tif code for x, while tifName returns a name for that code. Many of the codes have several names, but only the default one is returned.

tif or tifName called with no arguments returns a vector of all tif codes with names.

period returns a vector like z giving the number of periods elapsed since the first period defined for its argument's frequency.

basePeriod returns the ti for the first period defined for tif(x).

See Also

ti, frequency

Examples

1
2
3
tif()                 ## returns a vector of all tif codes
tifName(today())      ## today() returns a ti
period(today())

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.