'update'
[talweg.git] / pkg / R / plot.R
CommitLineData
98e958ca 1#' Plot curves
e030a6e3 2#'
102bcfda 3#' Plot a range of curves in data.
e030a6e3 4#'
102bcfda 5#' @inheritParams computeError
e030a6e3
BA
6#' @param indices Range of indices (integers or dates)
7#'
8#' @export
1e20780e 9plotCurves <- function(data, indices=seq_len(data$getSize()))
e030a6e3 10{
98e958ca 11 series = data$getSeries(indices)
a5a3a294 12 yrange = quantile(series, probs=c(0.025,0.975), na.rm=TRUE)
e030a6e3 13 par(mar=c(4.7,5,1,1), cex.axis=1.5, cex.lab=1.5)
4f3fdbb8 14 matplot(series, type="l", ylim=yrange, xlab="Time (hours)", ylab="PM10")
e030a6e3
BA
15}
16
af3b84f4 17#' Plot error
3d69ff21 18#'
102bcfda 19#' Draw error graphs, potentially from several runs of \code{computeForecast()}.
3d69ff21 20#'
102bcfda 21#' @param err Error as returned by \code{computeError()}
09cf9c19 22#' @param cols Colors for each error (default: 1,2,3,...)
3d69ff21 23#'
98e958ca 24#' @seealso \code{\link{plotCurves}}, \code{\link{plotPredReal}},
72b9c501
BA
25#' \code{\link{plotSimils}}, \code{\link{plotFbox}}, \code{\link{computeFilaments}},
26#' \code{\link{plotFilamentsBox}}, \code{\link{plotRelVar}}
3d69ff21
BA
27#'
28#' @export
09cf9c19 29plotError <- function(err, cols=seq_along(err))
3d69ff21 30{
09cf9c19
BA
31 if (!is.null(err$abs))
32 err = list(err)
10886062 33 par(mfrow=c(2,2), mar=c(4.7,5,1,1), cex.axis=1.5, cex.lab=1.5)
3d69ff21 34 L = length(err)
9b9bb2d4 35
98e958ca 36 yrange = range( sapply(1:L, function(i) ( err[[i]]$abs$day ) ), na.rm=TRUE )
9b9bb2d4 37 matplot( sapply( seq_len(L), function(i) err[[i]]$abs$day ), type="l",
10886062 38 xlab="Time (hours)", ylab="Mean |y - y_hat|", ylim=yrange, col=cols, lwd=2, lty=1 )
9b9bb2d4 39
98e958ca 40 yrange = range( sapply(1:L, function(i) ( err[[i]]$abs$indices ) ), na.rm=TRUE )
9b9bb2d4 41 matplot( sapply( seq_len(L), function(i) err[[i]]$abs$indices ), type="l",
10886062 42 xlab="Time (days)", ylab="Mean |y - y_hat|", ylim=yrange, col=cols, lwd=2, lty=1 )
9b9bb2d4 43
98e958ca 44 yrange = range( sapply(1:L, function(i) ( err[[i]]$MAPE$day ) ), na.rm=TRUE )
9b9bb2d4 45 matplot( sapply( seq_len(L), function(i) err[[i]]$MAPE$day ), type="l",
10886062 46 xlab="Time (hours)", ylab="Mean MAPE", ylim=yrange, col=cols, lwd=2, lty=1 )
9b9bb2d4 47
98e958ca 48 yrange = range( sapply(1:L, function(i) ( err[[i]]$MAPE$indices ) ), na.rm=TRUE )
9b9bb2d4 49 matplot( sapply( seq_len(L), function(i) err[[i]]$MAPE$indices ), type="l",
10886062 50 xlab="Time (days)", ylab="Mean MAPE", ylim=yrange, col=cols, lwd=2, lty=1 )
3d69ff21
BA
51}
52
98e958ca
BA
53#' Plot measured / predicted
54#'
102bcfda 55#' Plot measured curve (in black) and predicted curve (in blue).
98e958ca 56#'
102bcfda 57#' @inheritParams computeError
98e958ca
BA
58#' @param index Index in forecasts (integer or date)
59#'
60#' @export
61plotPredReal <- function(data, pred, index)
62{
72b9c501 63 prediction = pred$getForecast(index)
9b9bb2d4
BA
64 measure = data$getSerie( pred$getIndexInData(index) )[1:length(pred$getForecast(1))]
65
66 # Remove the common part, where prediction == measure
67 dot_mark <- ifelse(prediction[1]==measure[1], which.max(prediction==measure), 0)
68 prediction = prediction[(dot_mark+1):length(prediction)]
69 measure = measure[(dot_mark+1):length(measure)]
70
98e958ca
BA
71 yrange = range(measure, prediction)
72 par(mar=c(4.7,5,1,1), cex.axis=1.5, cex.lab=1.5, lwd=3)
4e25de2c 73 plot(measure, type="l", ylim=yrange, xlab="Time (hours)", ylab="PM10")
98e958ca
BA
74 par(new=TRUE)
75 plot(prediction, type="l", col="#0000FF", ylim=yrange, xlab="", ylab="")
76}
77
78#' Plot similarities
79#'
102bcfda 80#' Plot histogram of similarities (weights), for 'Neighbors' method.
98e958ca 81#'
102bcfda 82#' @inheritParams computeError
98e958ca
BA
83#' @param index Index in forecasts (integer or date)
84#'
85#' @export
86plotSimils <- function(pred, index)
87{
88 weights = pred$getParams(index)$weights
89 if (is.null(weights))
90 stop("plotSimils only works on 'Neighbors' forecasts")
9b9bb2d4
BA
91 par(mfrow=c(1,2), mar=c(4.7,5,1,1), cex.axis=1.5, cex.lab=1.5)
92 small_weights = weights[ weights < 1/length(weights) ]
93 large_weights = weights[ weights >= 1/length(weights) ]
94 hist(small_weights, nclass=25, main="", xlab="Weight < 1/N", ylab="Count")
95 hist(large_weights, nclass=25, main="", xlab="Weight >= 1/N", ylab="Count")
98e958ca
BA
96}
97
af3b84f4 98#' Functional boxplot
3d69ff21 99#'
102bcfda 100#' Draw the functional boxplot on the left, and bivariate plot on the right.
3d69ff21 101#'
102bcfda
BA
102#' @inheritParams computeError
103#' @inheritParams plotCurves
3d69ff21
BA
104#'
105#' @export
98e958ca 106plotFbox <- function(data, indices=seq_len(data$getSize()))
3d69ff21
BA
107{
108 if (!requireNamespace("rainbow", quietly=TRUE))
109 stop("Functional boxplot requires the rainbow package")
110
98e958ca
BA
111 series_matrix = data$getSeries(indices)
112 # Remove series with NAs
af3b84f4
BA
113 no_NAs_indices = sapply( 1:ncol(series_matrix),
114 function(i) all(!is.na(series_matrix[,i])) )
99f83c9a 115 series_matrix = series_matrix[,no_NAs_indices]
3d69ff21
BA
116
117 series_fds = rainbow::fds(seq_len(nrow(series_matrix)), series_matrix)
fa8078f9 118 par(mar=c(4.7,5,1,1), cex.axis=1.5, cex.lab=1.5)
4e25de2c 119 rainbow::fboxplot(series_fds, "functional", "hdr", xlab="Time (hours)", ylab="PM10",
3d69ff21 120 plotlegend=FALSE, lwd=2)
98e958ca
BA
121 rainbow::fboxplot(series_fds, "bivariate", "hdr", plotlegend=FALSE)
122}
123
124#' Compute filaments
125#'
102bcfda
BA
126#' Obtain similar days in the past, and (optionally) plot them -- as black as distances
127#' are small.
98e958ca 128#'
102bcfda 129#' @inheritParams computeError
8f84543c 130#' @param index Index in forecast (integer or date)
98e958ca
BA
131#' @param limit Number of neighbors to consider
132#' @param plot Should the result be plotted?
133#'
134#' @return A list with
135#' \itemize{
136#' \item index : index of the current serie ('today')
137#' \item neighb_indices : indices of its neighbors
138#' \item colors : colors of neighbors curves (shades of gray)
139#' }
140#'
141#' @export
9b9bb2d4 142computeFilaments <- function(data, pred, index, limit=60, plot=TRUE)
98e958ca 143{
9b9bb2d4
BA
144 weights <- pred$getParams(index)$weights
145 if (is.null(weights) || is.na(pred$getParams(index)$weights[1]))
98e958ca
BA
146 stop("computeFilaments requires a serie without NAs")
147
9b9bb2d4
BA
148 nn <- min(limit, length(weights))
149 sorted_dists = sort(-log(weights), index.return=TRUE)
150 # Compute colors for each neighbor (from darkest to lightest), if weights differ
151 if ( any( weights != weights[1] ) )
152 {
153 min_dist = min(sorted_dists$x[1:nn])
154 max_dist = max(sorted_dists$x[1:nn])
155 color_values = floor(19.5*(sorted_dists$x[1:nn]-min_dist)/(max_dist-min_dist)) + 1
156 colors = gray.colors(20,0.1,0.9)[color_values] #TODO: 20 == magic number
157 }
158 else
159 colors <- rep(colors()[17], length(weights))
98e958ca
BA
160
161 if (plot)
162 {
163 # Complete series with (past and present) tomorrows
d2ab47a7
BA
164 ref_serie = c( data$getCenteredSerie( pred$getIndexInData(index)-1 ),
165 data$getCenteredSerie( pred$getIndexInData(index) ) )
8f84543c 166 centered_series = rbind(
9e0f25f6
BA
167 data$getCenteredSeries( pred$getParams(index)$indices-1 ),
168 data$getCenteredSeries( pred$getParams(index)$indices ) )
72b9c501
BA
169 yrange = range( ref_serie,
170 quantile(centered_series, probs=c(0.025,0.975), na.rm=TRUE) )
98e958ca
BA
171 par(mar=c(4.7,5,1,1), cex.axis=1.5, cex.lab=1.5, lwd=2)
172 for (i in nn:1)
173 {
8f84543c 174 plot(centered_series[,sorted_dists$ix[i]], ylim=yrange, type="l", col=colors[i],
4e25de2c 175 xlab=ifelse(i==1,"Time (hours)",""), ylab=ifelse(i==1,"Centered PM10",""))
98e958ca
BA
176 par(new=TRUE)
177 }
178 # Also plot ref curve, in red
179 plot(ref_serie, ylim=yrange, type="l", col="#FF0000", xlab="", ylab="")
9b9bb2d4
BA
180 dot_mark <- 0.5 + which.max( pred$getForecast(1) ==
181 data$getSerie( pred$getIndexInData(1) )[1:length(pred$getForecast(1))] )
182 abline(v=24+dot_mark, lty=2, col=colors()[56], lwd=1)
98e958ca
BA
183 }
184
8f84543c
BA
185 list(
186 "index"=pred$getIndexInData(index),
187 "neighb_indices"=pred$getParams(index)$indices[sorted_dists$ix[1:nn]],
188 "colors"=colors)
fa8078f9
BA
189}
190
af3b84f4 191#' Functional boxplot on filaments
fa8078f9 192#'
102bcfda 193#' Draw the functional boxplot on filaments obtained by \code{computeFilaments()}.
fa8078f9 194#'
102bcfda 195#' @inheritParams computeError
98e958ca 196#' @param fil Output of \code{computeFilaments}
9b9bb2d4 197#' @param predict_from First predicted time step
fa8078f9
BA
198#'
199#' @export
d2ab47a7 200plotFilamentsBox = function(data, fil, predict_from)
fa8078f9 201{
98e958ca
BA
202 if (!requireNamespace("rainbow", quietly=TRUE))
203 stop("Functional boxplot requires the rainbow package")
204
205 series_matrix = rbind(
3fd7377d 206 data$getSeries(fil$neighb_indices-1), data$getSeries(fil$neighb_indices) )
98e958ca 207 series_fds = rainbow::fds(seq_len(nrow(series_matrix)), series_matrix)
3fd7377d 208
98e958ca 209 par(mar=c(4.7,5,1,1), cex.axis=1.5, cex.lab=1.5)
4e25de2c 210 rainbow::fboxplot(series_fds, "functional", "hdr", xlab="Time (hours)", ylab="PM10",
98e958ca
BA
211 plotlegend=FALSE, lwd=2)
212
72b9c501 213 # "Magic": http://stackoverflow.com/questions/13842560/get-xlim-from-a-plot-in-r
fa8078f9
BA
214 usr <- par("usr")
215 yr <- (usr[4] - usr[3]) / 27
98e958ca 216 par(new=TRUE)
9b9bb2d4 217 plot(c(data$getSerie(fil$index-1),data$getSerie(fil$index)), type="l", lwd=2, lty=2,
fa8078f9 218 ylim=c(usr[3] + yr, usr[4] - yr), xlab="", ylab="")
d2ab47a7 219 abline(v=24+predict_from-0.5, lty=2, col=colors()[56])
3d69ff21 220}
16b1c049 221
af3b84f4 222#' Plot relative conditional variability / absolute variability
16b1c049 223#'
af3b84f4 224#' Draw the relative conditional variability / absolute variability based on filaments
102bcfda 225#' obtained by \code{computeFilaments()}.
16b1c049 226#'
102bcfda
BA
227#' @inheritParams computeError
228#' @inheritParams plotFilamentsBox
16b1c049
BA
229#'
230#' @export
d2ab47a7 231plotRelVar = function(data, fil, predict_from)
16b1c049 232{
3fd7377d
BA
233 ref_var = c( apply(data$getSeries(fil$neighb_indices-1),1,sd),
234 apply(data$getSeries(fil$neighb_indices),1,sd) )
cf3bb001 235 tdays = .getNoNA2(data, 2, fil$index)
72b9c501 236 global_var = c(
cf3bb001
BA
237 apply(data$getSeries(tdays-1),1,sd),
238 apply(data$getSeries(tdays),1,sd) )
16b1c049 239
af3b84f4 240 yrange = range(ref_var, global_var)
16b1c049 241 par(mar=c(4.7,5,1,1), cex.axis=1.5, cex.lab=1.5)
af3b84f4 242 plot(ref_var, type="l", col=1, lwd=3, ylim=yrange,
4e25de2c 243 xlab="Time (hours)", ylab="Standard deviation")
16b1c049 244 par(new=TRUE)
98e958ca 245 plot(global_var, type="l", col=2, lwd=3, ylim=yrange, xlab="", ylab="")
d2ab47a7 246 abline(v=24+predict_from-0.5, lty=2, col=colors()[56])
16b1c049 247}