#4198 documentation modified to describe the plots of plot_OutputsModel

man/plot_OutputsModel.Rd

@@ -15,7 +15,7 @@ plot_OutputsModel(OutputsModel, Qobs = NULL, IndPeriod_Plot = NULL,
 
 \item{BasinArea}{(optional) [numeric] basin area [km2], used to plot flow axes in m3/s}
 
-\item{PlotChoice}{(optional) [character] choice of plots \cr (e.g. c("Precip", "SnowPack", "Flows", "Regime", "CumFreq", "CorQQ")), default="all"}
+\item{PlotChoice}{(optional) [character] choice of plots \cr (e.g. c(\code{"Precip"}, \code{"SnowPack"}, \code{"Flows"}, \code{"Regime"}, \code{"CumFreq"}, \code{"CorQQ"})), default=\code{"all"}}
 
 \item{log_scale}{(optional) [boolean] boolean indicating if the flow axis is to be logarithmic, default = FALSE}
 
@@ -29,10 +29,12 @@ Function which creates a screen plot giving an overview of the model outputs
 }
 \details{
 Dashboard of results including various graphs (depending on the model):
-(1) time series of total precipitation and simulated flows (and observed flows if provided)
-(2) interannual median monthly simulated flow (and observed flows if provided)
-(3) correlation plot between simulated and observed flows (if observed flows provided)
-(4) cumulative frequency plot for simulated flows (and observed flows if provided)
+(1) time series of total precipitation
+(2) time series of snow pack (plotted only if CemaNeige ise used)
+(3) time series of simulated flows (and observed flows if provided)
+(4) interannual median monthly simulated flow (and observed flows if provided)
+(5) correlation plot between simulated and observed flows (if observed flows provided)
+(6) cumulative frequency plot for simulated flows (and observed flows if provided)
 }
 \author{
 Laurent Coron (June 2014)