base-sort: Sorting a 'timeSeries' by Time Stamps

Description Usage Arguments Details Value Examples

Description

Sorts a 'timeSeries' object with respect to its time stamps.

Usage

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

Arguments

x

an uni- or multivariate timeSeries object.

decreasing

a logical flag. Should we sort in increasing or decreasing order? By default FALSE.

...

optional arguments passed to other methods.

Details

Sorts a time series either in increasing or decreasing time stamp order. Internally the function order from R's base packahe is used. order generates a permutation which rearranges the time stamps in ascending or descending order.

To find out if the series is unsorted, the function is.unsorted from R's base package can be called.

Value

Returns a sorted 'timeSeries' object, which can be increasing or decreasing in time.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
   
## Monthly Calendar Series -    
   x <- daily2monthly(LPP2005REC[, 1:2])[3:14, ]
   
## Resample the Series with respect to the time stamps -    
   resampled <- sample(x)
   resampled
   is.unsorted(resampled)
   
## Now sort the serie in decreasing time order - 
   sorted <- sort(resampled, , decreasing = TRUE)
   sorted
   is.unsorted(sorted)
   
## Is the reverted series ordered? - 
   reverted <- rev(sorted)
   reverted
   is.unsorted(reverted)


Search within the timeSeries package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.