align                package:timeDate                R Documentation

_M_a_k_i_n_g _a '_t_i_m_e_D_a_t_e' _o_b_j_e_c_t _u_n_i_q_u_e

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

     Aligns a 'timeDate' object to regular date/time stamps.

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

     ## S4 method for signature 'timeDate':
     align(x, by = "1d", offset = "0s")

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

       x: an object of class 'timeDate'. 

      by: by a character string formed from an integer length and a
          period identifyer. Valid values are  "w", "d", "h", "m", "s",
          for  weeks, days, hours, minutes and seconds. For example a
          bi-weekly period is expressed as '"2w"'. 

  offset: by a character string formed from an integer length and a
          period identifyer in the same way as  for the argument 'by'. 

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

     returns an object of class 'timeDate'.

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

     ## align -

        # Align Bi-Weekly with a 3 Days Offset
        tC = timeCalendar()
        tC
        # align(tC, by = "2w", offset = "3d")  

