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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
\name{TimeDateMathOps}
\alias{TimeDateMathOps}
\alias{Ops.timeDate}
\alias{+.timeDate}
\alias{-.timeDate}
\alias{diff.timeDate}
\alias{difftimeDate}
\alias{round.timeDate}
\alias{trunc.timeDate}
\alias{c.timeDate}
\alias{rep.timeDate}
\alias{sort.timeDate}
\alias{sample.timeDate}
\alias{unique.timeDate}
\alias{rev.timeDate}
\title{timeDate Class, Functions and Methods}
\description{
A collection and description of functions and methods
for mathematical and logical operations on 'timeDate'
objects.
\cr
The functions to perform mathematical operations:
\tabular{ll}{
\code{Ops.timeDate} \tab Group 'Ops' generic functions for 'timeDate' objects, \cr
\code{+.timeDate} \tab Performs arithmetic + operation on 'timeDate' objects, \cr
\code{-.timeDate} \tab Performs arithmetic - operation on 'timeDate' objects, \cr
\code{diff.timeDate} \tab Returns suitably lagged and iterated differences, \cr
\code{difftimeDate} \tab Returns a difference of two 'timeDate' objects, \cr
\code{round.timeDate} \tab Rounds objects of class 'timeDate', \cr
\code{trunc.timeDate} \tab Truncates objects of class 'timeDate'. }
The functions to concatenate, sort and order 'timeDate' objects:
\tabular{ll}{
\code{c.timeDate} \tab Concatenates 'timeDate' objects, \cr
\code{rep.timeDate} \tab Replicates a 'timeDate' object, \cr
\code{sort.timeDate} \tab Sorts a 'timeDate' object, \cr
\code{sample.timeDate} \tab Resamples a 'timeDate' object, \cr
\code{unique.timeDate} \tab NMakes a 'timeDate' object unique, \cr
\code{rev.timeDate} \tab Reverts a 'timeDate' object. }
}
\usage{
\method{Ops}{timeDate}(e1, e2)
\method{+}{timeDate}(e1, e2)
\method{-}{timeDate}(e1, e2)
\method{diff}{timeDate}(x, lag = 1, differences = 1, \dots)
difftimeDate(time1, time2,
units = c("auto", "secs", "mins", "hours", "days", "weeks"))
\method{round}{timeDate}(x, units = c("days", "hours", "mins"), ...)
\method{trunc}{timeDate}(x, units = c("days", "hours", "mins"), ...)
\method{c}{timeDate}(\dots, recursive = FALSE)
\method{rep}{timeDate}(x, \dots)
\method{sample}{timeDate}(x, \dots)
\method{sort}{timeDate}(x, \dots)
\method{unique}{timeDate}(x, \dots)
\method{rev}{timeDate}(x)
}
\arguments{
\item{differences}{
[lag] - \cr
an integer indicating the order of the difference.
}
\item{e1, e2}{
["+"][["-"]["Ops"] - \cr
usually objects of class \code{timeDate}, in the case of
addition and subtraction \code{e2} may be of class
\code{numeric}.
}
\item{lag}{
[lag] - \cr
an integer indicating which lag to use.
}
\item{method}{
[modify] - \cr
a character string defining the modification method, one of
\code{"sort"}, \code{"round"}, or \code{"trunc"}.
}
\item{recursive}{
[c] - \cr
a logical. If recursive is set to \code{TRUE}, the function
recursively descends through lists combining all their elements
into a vector.
}
\item{time1, time2}{
[difftime] - \cr
two objects objects of class \code{timeDate}.
}
\item{units}{
a character string denoting the date/time units in which the
results are desired.
}
\item{x}{
[isWeekday][isWeekend][isBizday][weekDay] - \cr
an object of class \code{timeDate}.
\cr
[format][print] - \cr
an object of class \code{timeDate}.
}
\item{\dots}{
arguments passed to other methods.
}
}
\value{
\code{Ops.timeDate}\cr
\code{+.timeDate}\cr
\code{-.timeDate}\cr
\code{diff.timeDate}\cr
\code{difftimeDate}\cr
\code{round.timeDate}\cr
\code{trunc.timeDate}
\cr
these are functions for mathematical operations. Group code{Ops} are
generic functions which manage mathematical operations.
The plus operator \code{"+"} performs arithmetic "+" operation on
\code{timeDate} objects, and the minus operator \code{"-"} returns a
\code{difftime} object if both arguments \code{e1} and \code{e2}
are \code{"timeDate"} objects, or returns a \code{"timeDate"} object
\code{e2} seconds earlier than \code{e1}.
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}.
The function, \code{difftimeDate}, takes a difference of two
\code{timeDate} objects and returns an object of class \code{"difftime"}
with an attribute indicating the units.
The two functions \code{round} and \code{trunc} allow to round or to
truncate \code{"timedate"} objects to the specified unit and return
them as \code{"timedate"} objects.
\cr
\code{c}\cr
\code{rep}\cr
\code{sample}\cr
\code{sort}\cr
\code{unique}\cr
\code{rev}
\cr
these are functions to concatenate, to replicate, to resample, to
sort, to make unique, and to revert \code{timeDate} objects. The
functions return an object of class \code{"timeDate"}.
}
\seealso{
\code{timeDateClass}, \code{timeDateCoercion}, \code{timeDateSpecDates}
We also recommend to inspect the help pages for the POSIX time and date
class, \code{?Dates}, and the help pages from the contributed R packages
\code{chron} and \code{date}.
}
\examples{
## SOURCE("fCalendar.3C-TimeDateMathOps")
## c -
# 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
## "+/-" -
# Add One Day to a Given timeDate Object:
GMT = timeDate(dts, zone = "GMT", FinCenter = "GMT")
GMT
ZUR = timeDate(dts, zone = "GMT", FinCenter = "Europe/Zurich")
ZUR
GMT + 24*3600
ZUR[2] - ZUR[1]
## "[" -
# Subsets from and Lops for timeDate Objects:
GMT[GMT < GMT[2]]
ZUR[ZUR < ZUR[3]] == ZUR[1:3]
## diff -
# Suitably Lagged and Iterated Differences:
diff(GMT)
diff(GMT, lag = 2)
diff(GMT, lag = 1, diff = 2)
difftimeDate(GMT[1:2], GMT[-(1:2)])
## c | rep -
# Concatenate and Replicate timeDate Objects:
c(GMT[1:2], ZUR[1:2])
c(ZUR[1:2], GMT[1:2])
rep(ZUR[2], times = 3)
rep(ZUR[2:3], times = 2)
}
\author{
Diethelm Wuertz for the Rmetrics \R-port.
}
\keyword{chron}
|
