tframed                package:tframe                R Documentation

_C_o_n_s_t_r_u_c_t _a _T_f_r_a_m_e_d _O_b_j_e_c_t

_D_e_s_c_r_i_p_t_i_o_n:

     Both functions construct a tframed object.  These are generic
     functions. If tf is not a tframe object but has the  necessary
     information then the default methods attempt to build  a tframe.

_U_s_a_g_e:

         tframed(x, tf=NULL, names = NULL)
         tframed(x, tf = NULL, names = NULL)

         is.tframed(x)
         is.Ttframed(x)

_A_r_g_u_m_e_n_t_s:

       x: a tframed object or an object to be tframed.

      tf: a tframe.

   names: optional vector of strings to specify new series names.

   value: a tframe attribute to be applied to x.

_D_e_t_a_i_l_s:

     This `tframed'constructor is like ts but enables the tframe
     library's   generic methods for handling time. `is.tframed'
     returns TRUE if a `tframe()' can extract a tframe from the object.
     This is true for many objects which are not truly tframed (like ts
     objects), since `tframe()' tries fairly hard to build a tframe for
     the object. `is.Ttframed'  returns TRUE only if the object is
     truly tframed (i.e. has an attribute `tframe').

_V_a_l_u_e:

     A tframed object.

_S_e_e _A_l_s_o:

     `tframe'

_E_x_a_m_p_l_e_s:

         z <- tframed(matrix(rnorm(200), 100,2), 
                 tf=list(start=c(1982,1), frequency=12))
         is.tframed(z)

