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
230
231
232
233
234
|
\name{plot-methods}
\alias{plot}
\alias{lines}
\alias{points}
\alias{plot,timeSeries-method}
\alias{lines,timeSeries-method}
\alias{points,timeSeries-method}
\alias{pretty.timeSeries}
\title{Plot 'timeSeries' objects}
\description{
\code{"timeSeries"} methods for \code{\link[base]{plot}},
\code{\link[graphics]{lines}} and \code{\link[graphics]{points}}.
}
\usage{
\S4method{plot}{timeSeries}(x, y, FinCenter = NULL,
plot.type = c("multiple", "single"), format = "auto",
at = pretty(x), widths = 1, heights = 1, xy.labels,
xy.lines, panel = lines, nc, yax.flip = FALSE,
mar.multi = c(0, 5.1, 0, if (yax.flip) 5.1 else 2.1),
oma.multi = c(6, 0, 5, 0), axes = TRUE, \ldots)
\S4method{lines}{timeSeries}(x, FinCenter = NULL, \dots)
\S4method{points}{timeSeries}(x, FinCenter = NULL, \dots)
\method{pretty}{timeSeries}(x, n=5, min.n=n\%/\%3, shrink.sml=0.75,
high.u.bias=1.5, u5.bias=0.5+1.5*high.u.bias, eps.correct=0, \dots)
}
\details{
Our original method \code{plot} was build along R's plotting function
\code{plot.ts} with an additional argument to tailor the position
marks at user defined position specified by the argument \code{at}. We
call this style or theme \code{"ts"}.
With verson R 3.1 we have inroduced two new additional plotting themes
called \code{"pretty"} and \code{"chick"}. They are becoming active
when we set \code{at = "pretty"} or \code{at = "chic"}.
Plot style or theme \code{"pretty"} is an extension of our original
plotting method.
Plot style or theme \code{"chic"} is an implementation along the
contributed packages \code{xts} and \code{PerformanceAnalytics} from
the Chicago finance group members (\code{"chic"} is an abbreviation of
Chicago.
For both themes, \code{"pretty"} and \code{"chic"}, additional
arguments are passed through the \code{\dots} arguments. These are:
\tabular{lll}{
\code{Argument} \tab Default \tab Description \cr
\code{type} \tab "l" \tab types pf plot \cr
\code{col} \tab 1 \tab colors for lines and points \cr
\code{pch} \tab 20 \tab plot symbol \cr
\code{cex} \tab 1 \tab character and symbol scales \cr
\code{lty} \tab 1 \tab line types \cr
\code{lwd} \tab 2 \tab line widths \cr
\code{cex.axes} \tab 1 \tab scale of axes \cr
\code{cex.lab} \tab 1 \tab scale of labels \cr
\code{cex.pch} \tab 1 \tab scale of plot symbols \cr
\code{} \tab \tab \cr
\code{grid} \tab TRUE \tab should grid lines plotted? \cr
\code{frame.plot} \tab TRUE \tab should b box around the plot? \cr
\code{axes} \tab TRUE \tab should be axes drawn on the plot? \cr
\code{ann} \tab TRUE \tab should default annotations appear? }
Concerning the plot elements, the length of these vectors has to be
the same as the number of columns in the time series to be plotted. If
their length is only one, then they are repeated.
There is an almost 70 pages vignette added to the package, with dozens
of examples of tailored plots. Have a look in it.
}
\arguments{
\item{x, y }{
objects of class \code{timeSeries}.
}
\item{FinCenter}{
a character with the the location of the financial center
named as \code{"continent/city"}.
}
\item{plot.type}{
for multivariate time series, should the series by plotted
separately (with a common time axis) or on a single plot?
}
\item{format}{POSIX label format, e.g. "\%Y-\%m-\%d" or "\%F" for
ISO-8601 standard date format.
}
\item{at}{
a \code{timeDate} object setting the plot label positions.
If \code{at=pretty(x)}, the postitions are generated automatized
calling the function \code{pretty}. Default option \code{at="auto"}
selects 6 equal spaced time label positions. For the new plot
themes set at="pretty" or at="chic". In this case additional
arguments can be passed through the \code{\dots} arguments,
see details.
}
\item{widths, heights}{
widths and heights for individual graphs, see \code{layout}.
}
\item{xy.labels}{
logical, indicating if \code{text()} labels should be used for an
x-y plot, _or_ character, supplying a vector of labels to be
used. The default is to label for up to 150 points, and not
for more.
}
\item{xy.lines}{
logical, indicating if \code{lines} should be drawn for an x-y
plot. Defaults to the value of \code{xy.labels} if that is
logical, otherwise to \code{TRUE}
}
\item{panel}{
a \code{function(x, col, bg, pch, type, ...)} which gives the
action to be carried out in each panel of the display for
\code{plot.type="multiple"}. The default is \code{lines}.
}
\item{nc}{
the number of columns to use when \code{type="multiple"}. Defaults
to 1 for up to 4 series, otherwise to 2.
}
\item{yax.flip}{
logical indicating if the y-axis (ticks and numbering) should
flip from side 2 (left) to 4 (right) from series to series
when \code{type="multiple"}.
}
\item{mar.multi, oma.multi}{
the (default) \code{par} settings for \code{plot.type="multiple"}.
}
\item{axes}{
logical indicating if x- and y- axes should be drawn.
}
\item{n}{
an integer giving the desired number of intervals.
}
\item{min.n}{
a nonnegative integer giving the minimal
number of intervals.
}
\item{shrink.sml}{
a positive numeric by a which a default
scale is shrunk in the case when range(x) is
very small.
}
\item{high.u.bias}{
a non-negative numeric, typically > 1.
Larger high.u.bias values favor larger units.
}
\item{u5.bias}{
a non-negative numeric multiplier favoring
factor 5 over 2.
}
\item{eps.correct}{
an integer code, one of 0, 1, or 2. If
non-0, a correction is made at the boundaries.
}
\item{\dots}{
additional graphical arguments, see \code{plot}, \code{plot.default}
and \code{par}.
}
}
\value{
\code{NULL} (invisibly), the functions are called for the side effect
of producing plots
}
\seealso{
\code{vignette("timeSeriesPlot", package="timeSeries")}, which
provides extensive plot examples.
}
\examples{
## load Swiss pension fund benchmark data
LPP <- LPP2005REC[1:12, 1:4]
colnames(LPP) <- abbreviate(colnames(LPP), 2)
finCenter(LPP) <- "GMT"
## Example Plot 1
plot(LPP[, 1], type = "o", col = "steelblue",
main = "LPP", xlab = "2005", ylab = "Return")
plot(LPP[, 1], at="auto", type = "o", col = "steelblue",
main = "LPP", xlab = "2005", ylab = "Return")
## Example Plot 2
plot(LPP[, 1:2], type = "o", col = "steelblue",
main = "LPP", xlab = "2005", ylab = "Return")
## Example Plot 3
plot(LPP[, 1], LPP[, 2], type = "p", col = "steelblue",
main = "LPP", xlab = "Return 1", ylab = "Return 2")
## Example Plot 4a, the wrong way to do it!
LPP <- as.timeSeries(data(LPP2005REC))
ZRH <- as.timeSeries(LPP[,"SPI"], zone = "Zurich", FinCenter = "Zurich")
NYC <- as.timeSeries(LPP[,"LMI"], zone = "NewYork", FinCenter = "NewYork")
finCenter(ZRH)
finCenter(NYC)
plot(ZRH, at="auto", type = "p", pch = 19, col = "blue")
points(NYC, pch = 19, col = "red")
## Example Plot 4b, convert NYC to Zurich time
finCenter(ZRH) <- "Zurich"
finCenter(NYC) <- "Zurich"
at <- unique(round(time(ZRH)))
plot(ZRH, type = "p", pch = 19, col = "blue", format = "\%b \%d", at = at,
xlab = paste(ZRH@FinCenter, "local Time"), main = ZRH@FinCenter)
points(NYC, pch = 19, col = "red")
## Example 4c, force everything to GMT using "FinCenter" argument
finCenter(ZRH) <- "Zurich"
finCenter(NYC) <- "NewYork"
at <- unique(round(time(ZRH)))
plot(ZRH, type = "p", pch = 19, col = "blue", format = "\%b \%d", at = at,
FinCenter = "GMT", xlab = "GMT", main = "ZRH - GMT")
points(NYC, FinCenter = "GMT", pch = 19, col = "red")
}
\keyword{chron}
|
