time                 package:fSeries                 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:

     A collection and description of functions  and methods extracting
     and modifying positions  on 'timeSeries' objects.        

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

       'seriesPositions'    Extracts positions slot from a 'timeSeries',
       'newPositions<-'     Modifies positions of a 'timeSeries' object,
       'time.timeSeries'    Extracts time positions from 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:

     seriesPositions(object)
     newPositions(object) <- value

     ## S3 method for class 'timeSeries':
     time(x, ...)

     ## S3 method for class 'timeSeries':
     start(x, ...)
     ## S3 method for class 'timeSeries':
     end(x, ...)

     ## S3 method for class 'timeSeries':
     sample(x, ...)
     ## S3 method for class 'timeSeries':
     sort(x, ...)
     ## S3 method for class 'timeSeries':
     rev(x)

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

  method: [alignDailySeries] - 
           the method to be used for the alignment. A character string,
          one of '"before"', use the data from the row whose position
          is just before the unmatched position, or '"after"', use the 
          data from the row whose position is just after the unmatched 
          position, or '"linear"', interpolate linearly between 
          '"before"' and '"after"'.  

  object: [is][seriesData][seriesPositions][summary] -     an object of
          class 'timeSeries'. 

   value: a valid value for that component of 'newPositions(x)', i.e.
          an object of class '"timeDate"' with appropriate length. 

       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'. 

_A_u_t_h_o_r(_s):

     Diethelm Wuertz for the Rmetrics R-port.

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

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

