plot.OutputsModel.Rd 2.63 KB
Newer Older
Delaigue Olivier's avatar
Delaigue Olivier committed
\encoding{UTF-8}
\name{plot.OutputsModel}
\alias{plot.OutputsModel}
Delaigue Olivier's avatar
Delaigue Olivier committed
\title{Default preview of model outputs}
Delaigue Olivier's avatar
Delaigue Olivier committed
\usage{
\method{plot}{OutputsModel}(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, verbose = TRUE, ...)
Delaigue Olivier's avatar
Delaigue Olivier committed
}
Delaigue Olivier's avatar
Delaigue Olivier committed
\arguments{
\item{x}{[object of class \emph{OutputsModel}] list of model outputs (which must at least include DatesR, Precip and Qsim) [POSIXlt, mm, mm]}
\item{Qobs}{(optional) [numeric] time series of observed flow (for the same time steps than simulated) [mm/time step]}
\item{IndPeriod_Plot}{(optional) [numeric] indices of the time steps to be plotted (among the OutputsModel series)}
Delaigue Olivier's avatar
Delaigue Olivier committed

\item{BasinArea}{(optional) [numeric] basin area [km2], used to plot flow axes in m3/s}

\item{which}{(optional) [character] choice of plots \cr (e.g. c(\code{"Precip"}, \code{"Temp"}, \code{"SnowPack"}, \code{"Flows"}, \code{"Regime"}, \code{"CumFreq"}, \code{"CorQQ"})), default = \code{"all"}}
\item{log_scale}{(optional) [boolean] indicating if the flow axis is to be logarithmic, default = \code{FALSE}}
\item{cex.axis}{(optional) [numeric] the magnification to be used for axis annotation relative to the current setting of \code{cex}}

\item{cex.lab}{(optional) [numeric] the magnification to be used for x and y labels relative to the current setting of \code{cex}}

\item{cex.leg}{(optional) [numeric] the magnification to be used for the legend labels relative to the current setting of \code{cex}}

\item{lwd}{(optional) [numeric] the line width (a positive number)}

\item{verbose}{(optional) [boolean] indicating if the function is run in verbose mode or not, default = \code{TRUE}}

\item{...}{other parameters to be passed through to plotting functions}
Delaigue Olivier's avatar
Delaigue Olivier committed
}
Delaigue Olivier's avatar
Delaigue Olivier committed
\value{
Screen plot window.
Delaigue Olivier's avatar
Delaigue Olivier committed
}
Delaigue Olivier's avatar
Delaigue Olivier committed
\description{
Function which creates a screen plot giving an overview of the model outputs.
Delaigue Olivier's avatar
Delaigue Olivier committed
}
Delaigue Olivier's avatar
Delaigue Olivier committed
\details{
Dashboard of results including various graphs (depending on the model):\cr
  (1) time series of total precipitation\cr
  (2) time series of temperature (plotted only if CemaNeige is used)\cr
  (3) time series of snow pack (plotted only if CemaNeige is used)\cr
  (4) time series of simulated flows (and observed flows if provided)\cr
  (5) interannual median monthly simulated flow (and observed flows if provided)\cr
  (6) correlation plot between simulated and observed flows (if observed flows provided)\cr
  (7) cumulative frequency plot for simulated flows (and observed flows if provided)
Delaigue Olivier's avatar
Delaigue Olivier committed
}
Delaigue Olivier's avatar
Delaigue Olivier committed
\author{
Laurent Coron, Olivier Delaigue, Guillaume Thirel
Delaigue Olivier's avatar
Delaigue Olivier committed
}
\examples{
### See examples of RunModel_GR4J or RunModel_CemaNeigeGR4J functions
}