plot.OutputsModel.R 34.66 KiB
plot.OutputsModel <- function(x, Qobs = NULL, IndPeriod_Plot = NULL, BasinArea = NULL, which = "synth", log_scale = FALSE,
                              cex.axis = 1, cex.lab = 0.9, cex.leg = 0.9, lwd = 1,
                              AxisTS = function(x) axis.POSIXct(side = 1, x = x$DatesR, ...),
                              LayoutMat = NULL, LayoutWidths = rep.int(1, ncol(LayoutMat)), LayoutHeights = rep.int(1, nrow(LayoutMat)),
                              verbose = TRUE, ...) {
  ## save default graphical parameters and resetting on exit
  opar <- par(no.readonly = TRUE)
  on.exit(par(opar))
  OutputsModel <- x
  if (!is.null(IndPeriod_Plot)) {
    OutputsModel <- .IndexOutputsModel(OutputsModel, IndPeriod_Plot)
    Qobs <- Qobs[IndPeriod_Plot]
    IndPeriod_Plot <- seq_along(IndPeriod_Plot)
  ## ---------- check arguments
  if (!inherits(OutputsModel, "GR") & !inherits(OutputsModel, "CemaNeige")) {
    stop("'OutputsModel' not in the correct format for default plotting")
  ## check 'OutputsModel'
  BOOL_Dates <- FALSE
  if ("DatesR" %in% names(OutputsModel)) {
    BOOL_Dates <- TRUE
  BOOL_Pobs <- FALSE
  if ("Precip" %in% names(OutputsModel)) {
    BOOL_Pobs <- TRUE
  BOOL_EPobs <- FALSE
  if ("PotEvap" %in% names(OutputsModel)) {
    BOOL_EPobs <- TRUE
  BOOL_EAobs <- FALSE
  if ("AE" %in% names(OutputsModel)) {
    BOOL_EAobs <- TRUE
  BOOL_Qsim <- FALSE
  if ("Qsim"   %in% names(OutputsModel)) {
    BOOL_Qsim <- TRUE
  BOOL_Qobs <- FALSE
  if (BOOL_Qsim & length(Qobs) == length(OutputsModel$Qsim)) {
    if (sum(is.na(Qobs)) != length(Qobs)) {
      BOOL_Qobs <- TRUE
  } else if (inherits(OutputsModel, "GR") & !is.null(Qobs)) {
    warning("incorrect length of 'Qobs'. Time series of observed flow not drawn")
  BOOL_Error <- FALSE
  if (BOOL_Qsim & BOOL_Qobs) {
    BOOL_Error <- TRUE
  BOOL_Snow <- FALSE
  if ("CemaNeigeLayers" %in% names(OutputsModel)) {
    if ("SnowPack" %in% names(OutputsModel$CemaNeigeLayers[[1]])) {
      BOOL_Snow <- TRUE
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
} } BOOL_Psol <- FALSE if ("CemaNeigeLayers" %in% names(OutputsModel)) { if ("Psol" %in% names(OutputsModel$CemaNeigeLayers[[1]])) { BOOL_Psol <- TRUE } } ## check 'which' whichNeedQobs <- c("Error", "CorQQ") whichDashboard <- c("all", "synth", "ts", "perf") whichAll <- c("Precip", "PotEvap", "ActuEvap", "Temp", "SnowPack", "Flows", "Error", "Regime", "CumFreq", "CorQQ") whichSynth <- c("Precip" , "Temp", "SnowPack", "Flows" , "Regime", "CumFreq", "CorQQ") whichTS <- c("Precip", "PotEvap", "Temp", "SnowPack", "Flows" ) whichEvap <- c( "PotEvap", "ActuEvap" ) whichPerf <- c( "Error", "Regime", "CumFreq", "CorQQ") whichCN <- c( "Temp", "SnowPack" ) warnMsgWhich <- "'which' must be a vector of character" warnMsgNoQobs <- "the %s plot(s) cannot be drawn if there is no 'Qobs'" warnMsgWhichCN <- sprintf("incorrect element found in argument 'which':\n\twithout CemaNeige, %s are not available \n\tit can only contain %s", paste0(shQuote(whichCN), collapse = " and "), paste0(shQuote(c(whichDashboard, whichAll[!whichAll %in% whichCN])), collapse = ", ")) if (is.null(which)) { stop(warnMsgWhich) } if (!is.vector(which)) { stop(warnMsgWhich) } if (!is.character(which)) { stop(warnMsgWhich) } if (any(!which %in% c(whichDashboard, whichAll))) { stop(sprintf("incorrect element found in argument 'which': %s\nit can only contain %s", paste0(shQuote(which[!which %in% c(whichDashboard, whichAll)])), paste0(shQuote(c(whichDashboard, whichAll)), collapse = ", "))) } if (all(which %in% whichCN) & !inherits(OutputsModel, "CemaNeige")) { stop(warnMsgWhichCN) } if (length(unique(which %in% whichCN)) == 2 & !inherits(OutputsModel, "CemaNeige")) { warning(warnMsgWhichCN) } if (all(!which %in% c("all", "synth", "ts", whichCN)) & !inherits(OutputsModel, "GR")) { stop(sprintf("incorrect element found in argument 'which': \nwith CemaNeige alone, only %s are available", paste0(shQuote(c("all", "synth", "ts", "Temp", "SnowPack")), collapse = ", "))) } if (any(!which %in% c("all", "synth", "ts", whichCN)) & !inherits(OutputsModel, "GR")) { warning(sprintf("incorrect element found in argument 'which': \nwith CemaNeige alone, only %s are available", paste0(shQuote(c("all", "synth", "ts", "Temp", "SnowPack")), collapse = ", "))) } if ("perf" %in% which) { which <- c(which, whichPerf) } if ("ts" %in% which) { which <- c(which, whichTS) } if ("synth" %in% which) { which <- c(which, whichSynth) } if ("all" %in% which) { which <- c(which, whichAll) } if (is.null(Qobs) & inherits(OutputsModel, "GR")) { if (length(which) == 1 & (any(which %in% whichNeedQobs))) { stop(sprintf(warnMsgNoQobs, shQuote(which))) } if (length(which) != 1 & any(which %in% whichNeedQobs)) {
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
BOOL_CorQQ <- FALSE BOOL_Error <- FALSE warning(sprintf(warnMsgNoQobs, paste0(shQuote(whichNeedQobs), collapse = " and "))) } } ## check dates if (!BOOL_Dates) { stop("'OutputsModel' must contain at least 'DatesR' to allow plotting") } if (inherits(OutputsModel, "GR") & !BOOL_Qsim) { stop("'OutputsModel' must contain at least 'Qsim' to allow plotting") } if (BOOL_Dates) { # MyRollMean1 <- function(x, n) { # return(filter(x, rep(1 / n, n), sides = 2)) # } # MyRollMean2 <- function(x, n) { # return(filter(c(tail(x, n %/% 2), x, x[1:(n %/% 2)]), rep(1 / n, n), sides = 2)[(n %/% 2 + 1):(length(x) + n %/% 2)]) # } MyRollMean3 <- function(x, n) { return(filter(x, filter = rep(1 / n, n), sides = 2, circular = TRUE)) } BOOL_TS <- FALSE if (inherits(OutputsModel, "hourly")) { BOOL_TS <- TRUE NameTS <- "hour" plotunit <- "[mm/h]" formatAxis <- "%m/%Y" } if (inherits(OutputsModel, "daily")) { BOOL_TS <- TRUE NameTS <- "day" plotunit <- "[mm/d]" formatAxis <- "%m/%Y" } if (inherits(OutputsModel, "monthly")) { BOOL_TS <- TRUE NameTS <- "month" plotunit <- "[mm/month]" formatAxis <- "%m/%Y" } if (inherits(OutputsModel, "yearly")) { BOOL_TS <- TRUE NameTS <- "year" plotunit <- "[mm/y]" formatAxis <- "%Y" } # if (!BOOL_TS) { # stop("the time step of the model inputs could not be found") # } } if (length(IndPeriod_Plot) == 0) { IndPeriod_Plot <- 1:length(OutputsModel$DatesR) } if (inherits(OutputsModel, "CemaNeige")) { NLayers <- length(OutputsModel$CemaNeigeLayers) } PsolLayerMean <- NULL if (BOOL_Psol) { for (iLayer in 1:NLayers) { if (iLayer == 1) { PsolLayerMean <- OutputsModel$CemaNeigeLayers[[iLayer]]$Psol / NLayers } else { PsolLayerMean <- PsolLayerMean + OutputsModel$CemaNeigeLayers[[iLayer]]$Psol / NLayers } } }
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
BOOL_QobsZero <- FALSE if (BOOL_Qobs) { SelectQobsNotZero <- round(Qobs[IndPeriod_Plot], 4) != 0 BOOL_QobsZero <- sum(!SelectQobsNotZero, na.rm = TRUE) > 0 } BOOL_QsimZero <- FALSE if (BOOL_Qsim) { SelectQsimNotZero <- round(OutputsModel$Qsim[IndPeriod_Plot], 4) != 0 BOOL_QsimZero <- sum(!SelectQsimNotZero, na.rm = TRUE) > 0 } if ( BOOL_Qobs & !BOOL_Qsim) { SelectNotZero <- SelectQobsNotZero } if (!BOOL_Qobs & BOOL_Qsim) { SelectNotZero <- SelectQsimNotZero } if ( BOOL_Qobs & BOOL_Qsim) { SelectNotZero <- SelectQobsNotZero & SelectQsimNotZero } if (BOOL_QobsZero & verbose) { warning("zeroes detected in 'Qobs': some plots in the log space will not be created using all time-steps") } if (BOOL_QsimZero & verbose) { warning("zeroes detected in 'Qsim': some plots in the log space will not be created using all time-steps") } BOOL_FilterZero <- TRUE ## ---------- plot ## plot choices BOOLPLOT_Precip <- "Precip" %in% which & BOOL_Pobs BOOLPLOT_PotEvap <- "PotEvap" %in% which & BOOL_EPobs BOOLPLOT_ActuEvap <- "ActuEvap" %in% which & BOOL_EAobs BOOLPLOT_Temp <- "Temp" %in% which & BOOL_Snow BOOLPLOT_SnowPack <- "SnowPack" %in% which & BOOL_Snow BOOLPLOT_Flows <- "Flows" %in% which & (BOOL_Qsim | BOOL_Qobs) BOOLPLOT_Error <- "Error" %in% which & BOOL_Error BOOLPLOT_Regime <- "Regime" %in% which & BOOL_Qsim & BOOL_TS & (NameTS %in% c("hour", "day", "month")) BOOLPLOT_CumFreq <- "CumFreq" %in% which & (BOOL_Qsim | BOOL_Qobs) & BOOL_FilterZero BOOLPLOT_CorQQ <- "CorQQ" %in% which & (BOOL_Qsim & BOOL_Qobs) & BOOL_FilterZero ## options BLOC <- TRUE if (BLOC) { lwdk <- 1.8 line <- 2.6 bg <- NA ## Set plot arrangement if (is.null(LayoutMat)) { matlayout <- NULL iPlot <- 0 iHght <- NULL listBOOLPLOT1 <- c(Precip = BOOLPLOT_Precip, PotEvap = BOOLPLOT_PotEvap | BOOLPLOT_ActuEvap, Temp = BOOLPLOT_Temp , SnowPack = BOOLPLOT_SnowPack, Flows = BOOLPLOT_Flows , Error = BOOLPLOT_Error) listBOOLPLOT2 <- c(Regime = BOOLPLOT_Regime, CumFreq = BOOLPLOT_CumFreq, CorQQ = BOOLPLOT_CorQQ) Sum1 <- sum(listBOOLPLOT1) Sum2 <- sum(listBOOLPLOT2) for (k in seq_len(Sum1)) { matlayout <- rbind(matlayout, iPlot + c(1, 1, 1)) iPlot <- iPlot + 1 iHght <- c(iHght, 0.7)
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
} ## Flows plot is higher than the other TS listBOOLPLOT1 <- listBOOLPLOT1[listBOOLPLOT1] listBOOLPLOTF <- (names(listBOOLPLOT1) == "Flows") * BOOLPLOT_Flows iHght <- iHght + listBOOLPLOTF * listBOOLPLOT1 * 0.3 if (Sum2 >= 1) { iHght <- c(iHght, 1.0) } if ((Sum1 >= 1 & Sum2 != 0) | (Sum1 == 0 & Sum2 == 3)) { matlayout <- rbind(matlayout, iPlot + c(1, 2, 3)) iPlot <- iPlot + 3 } if (Sum1 == 0 & Sum2 == 2) { matlayout <- rbind(matlayout, iPlot + c(1, 2)) iPlot <- iPlot + 2 } if (Sum1 == 0 & Sum2 == 1) { matlayout <- rbind(matlayout, iPlot + 1) iPlot <- iPlot + 1 } iPlotMax <- iPlot LayoutWidths <- rep.int(1, ncol(matlayout)) LayoutHeights <- iHght #rep.int(1, nrow(matlayout)) } if (!is.null(LayoutMat)) { matlayout <- LayoutMat } layout(matlayout, widths = LayoutWidths, heights = LayoutHeights) Xaxis <- as.POSIXct(OutputsModel$DatesR[IndPeriod_Plot]) if (!is.null(BasinArea)) { Factor_UNIT_M3S <- switch(NameTS, hour = 60 * 60, day = 60 * 60 * 24, month = 60 * 60 * 24 * 365.25 / 12, year = 60 * 60 * 24 * 365.25) Factor_UNIT_M3S <- BasinArea / (Factor_UNIT_M3S / 1000) } } kPlot <- 0 ## vector of Q values for the y-axis when it is expressed in Factor <- ifelse(!is.null(BasinArea), Factor_UNIT_M3S, 1) seqDATA0 <- c(0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10, 20, 50, 100, 200, 500, 1000, 2000, 5000, 10000) seqDATA1 <- log(seqDATA0) seqDATA2 <- exp(seqDATA1) if (!is.null(BasinArea)) { seqDATA1ba <- log(seqDATA0 * Factor_UNIT_M3S) seqDATA2ba <- round(exp(seqDATA1ba), digits = 2) } ## Precip if (BOOLPLOT_Precip) { kPlot <- kPlot + 1 mar <- c(3, 5, 1, 5) par(new = FALSE, mar = mar) ylim1 <- range(OutputsModel$Precip[IndPeriod_Plot], na.rm = TRUE) ylim2 <- ylim1 * c(1.0, 1.1) ylim2 <- rev(ylim2) lwdP <- lwd * 0.7 if (NameTS %in% c("month", "year")) { lwdP <- lwd * 2
351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
} plot(Xaxis, OutputsModel$Precip[IndPeriod_Plot], type = "h", xaxt = "n", yaxt = "n", yaxs = "i", ylim = ylim2, col = "royalblue", lwd = lwdP * lwdk, lend = 1, xlab = "", ylab = "", ...) axis(side = 2, at = pretty(ylim1), labels = pretty(ylim1), cex.axis = cex.axis, ...) mtext(side = 2, paste("precip.", plotunit), cex = cex.lab, adj = 1, line = line) if (BOOL_Psol) { legend("bottomright", legend = c("solid","liquid"), col = c("lightblue", "royalblue"), lty = c(1, 1), lwd = c(lwd, lwd), bty = "o", bg = bg, box.col = bg, cex = cex.leg) points(Xaxis, PsolLayerMean[IndPeriod_Plot], type = "h", xaxt = "n", yaxt = "n", yaxs = "i", ylim = ylim2, col = "lightblue", lwd = lwdP * lwdk, lend = 1, xlab = "", ylab = "", ...) } AxisTS(OutputsModel) box() } ## PotEvap if (BOOLPLOT_PotEvap) { kPlot <- kPlot + 1 mar <- c(3, 5, 1, 5) par(new = FALSE, mar = mar) if (!BOOLPLOT_ActuEvap) { ylim1 <- range(OutputsModel$PotEvap[IndPeriod_Plot], na.rm = TRUE) xlabE <- "pot. evap." } else { ylim1 <- range(c(OutputsModel$PotEvap[IndPeriod_Plot], OutputsModel$AE[IndPeriod_Plot]), na.rm = TRUE) xlabE <- "evap." } ylim2 <- ylim1 #* c(1.0, 1.1) plot(Xaxis, OutputsModel$PotEvap[IndPeriod_Plot], type = "l", xaxt = "n", yaxt = "n", ylim = ylim2, col = "green3", lwd = lwd * lwdk, xlab = "", ylab = "", ...) if (BOOLPLOT_ActuEvap) { lines(Xaxis, OutputsModel$AE[IndPeriod_Plot], type = "l", xaxt = "n", yaxt = "n", ylim = ylim2, col = "green4", lwd = lwd * lwdk, lty = 3) legend("topright", legend = c("pot.", "actu."), col = c("green3", "green4"), lty = c(1, 3), lwd = c(lwd*1.0, lwd*0.8), bty = "o", bg = bg, box.col = bg, cex = cex.leg) } axis(side = 2, at = pretty(ylim1), labels = pretty(ylim1), cex.axis = cex.axis, ...) mtext(side = 2, paste(xlabE, plotunit), cex = cex.lab, line = line) AxisTS(OutputsModel) box() } ## ActuEvap if (BOOLPLOT_ActuEvap & !BOOLPLOT_PotEvap) { kPlot <- kPlot + 1 mar <- c(3, 5, 1, 5) par(new = FALSE, mar = mar) ylim1 <- range(OutputsModel$AE[IndPeriod_Plot], na.rm = TRUE)
421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490
ylim2 <- ylim1 #* c(1.0, 1.1) plot(Xaxis, OutputsModel$AE[IndPeriod_Plot], type = "l", xaxt = "n", yaxt = "n", ylim = ylim2, col = "green4", lwd = lwd * lwdk, xlab = "", ylab = "", ...) axis(side = 2, at = pretty(ylim1), labels = pretty(ylim1), cex.axis = cex.axis, ...) mtext(side = 2, paste("actu. evap.", plotunit), cex = cex.lab, line = line) AxisTS(OutputsModel) box() } ## Temp if (BOOLPLOT_Temp) { kPlot <- kPlot + 1 mar <- c(3, 5, 1, 5) par(new = FALSE, mar = mar) ylim1 <- c(+99999, -99999) for(iLayer in 1:NLayers) { ylim1[1] <- min(ylim1[1], OutputsModel$CemaNeigeLayers[[iLayer]]$Temp) ylim1[2] <- max(ylim1[2], OutputsModel$CemaNeigeLayers[[iLayer]]$Temp) if (iLayer == 1) { SnowPackLayerMean <- OutputsModel$CemaNeigeLayers[[iLayer]]$Temp/NLayers } else { SnowPackLayerMean <- SnowPackLayerMean + OutputsModel$CemaNeigeLayers[[iLayer]]$Temp/NLayers } } plot(Xaxis, SnowPackLayerMean[IndPeriod_Plot], type = "n", ylim = ylim1, xlab = "", ylab = "", xaxt = "n", yaxt = "n", ...) for(iLayer in 1:NLayers) { lines(Xaxis, OutputsModel$CemaNeigeLayers[[iLayer]]$Temp[IndPeriod_Plot], lty = 3, col = "orchid", lwd = lwd * lwdk * 0.8) } abline(h = 0, col = "grey", lty = 2) lines(Xaxis, SnowPackLayerMean[IndPeriod_Plot], type = "l", lwd = lwd * lwdk *1.0, col = "darkorchid4") axis(side = 2, at = pretty(ylim1), labels = pretty(ylim1), cex.axis = cex.axis, ...) mtext(side = 2, expression(paste("temp. [", degree, "C]"), sep = ""), padj = 0.2, line = line, cex = cex.lab) legend("topright", legend = c("mean", "layers"), col = c("darkorchid4", "orchid"), lty = c(1, 3), lwd = c(lwd*1.0, lwd*0.8), bty = "o", bg = bg, box.col = bg, cex = cex.leg) AxisTS(OutputsModel) box() } ## SnowPack if (BOOLPLOT_SnowPack) { kPlot <- kPlot + 1 mar <- c(3, 5, 1, 5) par(new = FALSE, mar = mar) ylim1 <- c(+99999, -99999) for(iLayer in 1:NLayers) { ylim1[1] <- min(ylim1[1], OutputsModel$CemaNeigeLayers[[iLayer]]$SnowPack) ylim1[2] <- max(ylim1[2], OutputsModel$CemaNeigeLayers[[iLayer]]$SnowPack) if (iLayer == 1) { SnowPackLayerMean <- OutputsModel$CemaNeigeLayers[[iLayer]]$SnowPack/NLayers } else { SnowPackLayerMean <- SnowPackLayerMean + OutputsModel$CemaNeigeLayers[[iLayer]]$SnowPack/NLayers } } plot(Xaxis, SnowPackLayerMean[IndPeriod_Plot], type = "l", ylim = ylim1, lwd = lwd * lwdk *1.2, col = "royalblue", xlab = "", ylab = "", xaxt = "n", yaxt = "n", ...) for(iLayer in 1:NLayers) { lines(Xaxis, OutputsModel$CemaNeigeLayers[[iLayer]]$SnowPack[IndPeriod_Plot], lty = 3, col = "royalblue", lwd = lwd * lwdk *0.8) }