File: base-diff.Rd

package info (click to toggle)
r-cran-timedate 3012.100-2
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 2,592 kB
  • ctags: 4
  • sloc: makefile: 13
file content (75 lines) | stat: -rw-r--r-- 1,510 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
\name{diff}


\title{Lagged 'timeDate' Differences}


\alias{diff}
\alias{diff.timeDate}


\description{
    
    Returns suitably lagged and iterated differences.
       
}


\usage{
\method{diff}{timeDate}(x, lag = 1, differences = 1, \dots)  
}


\arguments{
  
    \item{x}{
        an object of class \code{timeDate}.
        }  
    \item{lag}{
        an integer indicating which lag to use.  
        }
    \item{differences}{
        an integer indicating the order of the difference.
        }
    \item{\dots}{
        arguments passed to other methods.
        }
       
}


\value{
    
    For the function, \code{diff.timeDate}, if \code{x} is a vector 
    of length \code{n} and \code{differences=1}, then the computed result 
    is equal to the successive differences \code{x[(1+lag):n] - x[1:(n-lag)]}. 
    If \code{difference} is larger than one this algorithm is applied
    recursively to \code{x}. Note that the returned value is a vector 
    which is shorter than \code{x}.
    
}


\examples{
## Create Character Vectors:
   dts = c("1989-09-28", "2001-01-15", "2004-08-30", "1990-02-09")
   dts
   tms = c(  "23:12:55",   "10:34:02",   "08:30:00",   "11:18:23")
   tms
   
## timeDate - 
   GMT = timeDate(dts, zone = "GMT", FinCenter = "GMT") + 24*3600
   GMT
   ZUR = timeDate(dts, zone = "GMT", FinCenter = "Europe/Zurich")
   ZUR

## diff - 
   # Suitably Lagged and Iterated Differences:
   diff(GMT)
   diff(GMT, lag = 2)
   diff(GMT, lag = 1, diff = 2)
}


\keyword{chron}