tfstart                package:tframe                R Documentation

_E_x_t_r_a_c_t _T_i_m_e _F_r_a_m_e _I_n_f_o_r_m_a_t_i_o_n

_D_e_s_c_r_i_p_t_i_o_n:

     Functions for extracting time frame information.

_U_s_a_g_e:

         ## S3 method for class 'tframed':
         start(x, ...)
         ## S3 method for class 'tframe':
         start(x, ...)
         tfstart(x)
         ## Default S3 method:
         tfstart(x)
         ## S3 method for class 'tstframe':
         tfstart(x)

         ## S3 method for class 'tframed':
         end(x, ...)
         ## S3 method for class 'tframe':
         end(x, ...)
         tfend(x)
         ## Default S3 method:
         tfend(x)
         ## S3 method for class 'tstframe':
         tfend(x)

         ## S3 method for class 'tframed':
         frequency(x, ...)
         ## S3 method for class 'tframe':
         frequency(x, ...)
         tffrequency(x)
         ## Default S3 method:
         tffrequency(x)

         periods(x)
         ## Default S3 method:
         periods(x)
         ## S3 method for class 'tframed':
         periods(x)
         ## S3 method for class 'tframe':
         periods(x)
         tfperiods(x)
         ## Default S3 method:
         tfperiods(x)
         ## S3 method for class 'stamped':
         tfperiods(x)

         ## S3 method for class 'tframed':
         time(x, ...)
         ## S3 method for class 'tframe':
         time(x, ...)
         tftime(x)
         ## Default S3 method:
         tftime(x)
         ## S3 method for class 'tframed':
         time(x, ...)

_A_r_g_u_m_e_n_t_s:

       x: a tframe or a tframed object.

     ...: arguments to be passed to other methods.

_D_e_t_a_i_l_s:

     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.

_V_a_l_u_e:

     Depends

_S_e_e _A_l_s_o:

     'tframe',  'tframed' 'start' 'end' 'frequency' 'periods' 'time'
     'lag' 'diff'

_E_x_a_m_p_l_e_s:

         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)
         periods(z)
         time(z)

