tframe (version 2012.3-1)

tfstart: Extract Time Frame Information

Description

Functions for extracting time frame information.

Usage

## S3 method for class 'tframed':
start(x, ...)
    ## S3 method for class 'tframe':
start(x, ...)
    tfstart(x)
    ## S3 method for class 'default':
tfstart(x)
    ## S3 method for class 'tstframe':
tfstart(x)
    ## S3 method for class 'tframed':
end(x, ...)
    ## S3 method for class 'tframe':
end(x, ...)
    ## S3 method for class 'tstframe':
tfend(x)
    tfend(x)
    ## S3 method for class 'default':
tfend(x)
    ## S3 method for class 'tframed':
frequency(x, ...)
    ## S3 method for class 'tframe':
frequency(x, ...)
    tffrequency(x)
    ## S3 method for class 'default':
tffrequency(x)
    Tobs(x)
    ## S3 method for class 'default':
Tobs(x)
    ## S3 method for class 'tframed':
Tobs(x)
    ## S3 method for class 'tframe':
Tobs(x)
    ## S3 method for class 'stamped':
Tobs(x)
    ## S3 method for class 'tframed':
time(x, ...)
    ## S3 method for class 'tframe':
time(x, ...)
    tftime(x)
    ## S3 method for class 'default':
tftime(x)
    ## S3 method for class 'tframed':
time(x, ...)

Arguments

x

a tframe or a tframed object.

...

arguments to be passed to other methods.

Value

• Depends

Details

The methods start and end return the start or end date of a tframe or tframed object. Periods return the number of observations (time points). frequency returns the frequency of observation, typically the number of observations in a year for economic data, but possibly something else in other contexts. The concept of frequency is not very consistently defined for time series data, and the use of the frequency method should probably be avoided where possible. In practice it seems rarely necessary, but the method makes porting of older code much easier.

See Also

tframe, tframed start end frequency Tobs time lag diff

Examples

z <- ts(rnorm(100), start=c(1982,1), frequency=12)
    tfstart(z)
    z <- tframed(matrix(rnorm(200), 100,2), 
            tf=list(start=c(1982,1), frequency=12))
    tfend(z)
    Tobs(z)
    time(z)