pkg/R/plot.R

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