time               package:timeSeries               R Documentation

_t_i_m_e_S_e_r_i_e_s, _P_o_s_i_t_i_o_n_s

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

     Functions and methods extracting and modifying positions  of
     'timeSeries' objects.        

     The functions and methods for the Generation of 'timeSeries'
     Objects are: 

       'time.timeSeries'    Extracts time positions from a 'timeSeries',
       'time<-.timeSeries'  Assign time positions to a 'timeSeries',
       'sample.timeSeries'  Resamples a 'timeSeries' object in time,
       'sort.timeSeries'    Sorts reverts a 'timeSeries' object in time,
       'rev.timeSeries'     Reverts a 'timeSeries' object in time,
       'start.timeSeries'   Extracts start date of a 'timeSeries'  object,
       'end.timeSeries'     Extracts end date of a 'timeSeries' object.

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

     ## S4 method for signature 'timeSeries':
     time(x, ...)
     ## S3 replacement method for class 'timeSeries':
     time(x) <- value

     ## S4 method for signature 'timeSeries':
     start(x, ...)
     ## S4 method for signature 'timeSeries':
     end(x, ...)

     ## S4 method for signature 'timeSeries':
     sort(x, decreasing = FALSE, ...)
     ## S4 method for signature 'timeSeries':
     rev(x)

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

decreasing: logical.  Should the sort be increasing or decreasing? Not
          available for partial sorting. 

   value: a valid value for the component of 'time(x)'. 

       x: [as] - 
              a 'matrix' type object to be converted.
           [as.vector][as.matrix][as.data.frame] -
           [applySeries] - 
           [cut][end][mergeSeries][plot][print][rev][start] - 
           an object of class 'timeSeries'. 

     ...: arguments passed to other methods. 

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

     'timeSeries'
      'read.timeSeries'
      'as.timeSeries' 
      return a S4 object of class 'timeSeries'. 

     'seriesData'
      'seriesPositions' 
      extract the '@.Data' and '@position' slots from a  'timeSeries'
     object. Thus, 'seriesData' returns an  object of class 'matrix',
     and 'seriesPositions' returns an object of class 'timeDate'. 

     'is.timeSeries' 
      returns 'TRUE' or 'FALSE' depending on whether its argument is of
     'timeSeries' type or not. 

     'aggregateSeries'
      'applySeries'
      'cutSeries'
      'mergeSeries'
      'returnSeries'
      'revSeries' 
      return a S4 object of class 'timeSeries'. 

     'end, start' 
      return a S4 object of class 'timedate'. These are the  start and
     end dates of a 'timeSeries' object. 

     'as.vector'
      'as.matrix'
      'as.data.frame' 
      these are methods which convert a S4 object of class 'timeSeries'
     either to a vector, a matrix or to a data frame. 

     'plot'
      'lines'
      'points'
      'print' 
      plot and print methods for an object of class 'timeSeries'. Note
     that the plot function requires the packages 'its' and 'Hmisc'. 

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

        
     ## Create dummy timeSeries:     
        X = timeSeries(matrix(rnorm(24), 12), timeCalendar())
        
     ## series positions -
        time(X)

