diff --git a/man/BasinInfo.Rd b/man/BasinInfo.Rd index a0df880765441b2f795c7f120a5a8e2f1491066b..a8d603332504a312daf836ad788f4e77aab07123 100644 --- a/man/BasinInfo.Rd +++ b/man/BasinInfo.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/BasinData.R \docType{data} \encoding{UTF-8} \name{BasinInfo} diff --git a/man/BasinObs.Rd b/man/BasinObs.Rd index 3dab677af5bb6a4f23baa4d7262ccff7883df686..61bd8daf1f91d0a8019dc7f5a8cfbeb8d158ba0e 100644 --- a/man/BasinObs.Rd +++ b/man/BasinObs.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/BasinData.R \docType{data} \encoding{UTF-8} \name{BasinObs} @@ -8,7 +6,7 @@ \format{Data frame named 'BasinObs' containing \itemize{ \item one POSIXlt vector: time series dates in the POSIXlt format -\item five numeric vectors: time series of catchment average precipitation [mm/time step], catchment average air temperature [degC], catchment average potential evapotranspiration [mm/time step], outlet discharge [l/s], outlet discharge [mm/time step] +\item five numeric vectors: time series of catchment average precipitation [mm/time step], catchment average air temperature [°C], catchment average potential evapotranspiration [mm/time step], outlet discharge [l/s], outlet discharge [mm/time step] }} \description{ R-object containing the times series of precipitation, temperature, potential evapotranspiration and discharges. \cr diff --git a/man/Calibration.Rd b/man/Calibration.Rd index c889275678a67ac0e345b46e6ac7e187cba8f566..316576df65c973f5abe261697fd476bc3eb18ca1 100644 --- a/man/Calibration.Rd +++ b/man/Calibration.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/Calibration.R \encoding{UTF-8} \name{Calibration} \alias{Calibration} @@ -7,7 +5,7 @@ \usage{ Calibration(InputsModel, RunOptions, InputsCrit, CalibOptions, FUN_MOD, FUN_CRIT, FUN_CALIB = Calibration_Michel, FUN_TRANSFO = NULL, - quiet = FALSE) + verbose = TRUE) } \arguments{ \item{InputsModel}{[object of class \emph{InputsModel}] see \code{\link{CreateInputsModel}} for details} @@ -26,7 +24,7 @@ Calibration(InputsModel, RunOptions, InputsCrit, CalibOptions, FUN_MOD, \item{FUN_TRANSFO}{(optional) [function] model parameters transformation function, if the FUN_MOD used is native in the package FUN_TRANSFO is automatically defined} -\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE} +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} } \value{ [list] see \code{\link{Calibration_Michel}} diff --git a/man/Calibration_Michel.Rd b/man/Calibration_Michel.Rd index 24166d656499db9e115f8392219b9938c363811b..73a26ee27b6303c5b7d65f81908f062569d2bf50 100644 --- a/man/Calibration_Michel.Rd +++ b/man/Calibration_Michel.Rd @@ -1,12 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/Calibration_Michel.R \encoding{UTF-8} \name{Calibration_Michel} \alias{Calibration_Michel} \title{Calibration algorithm optimises the error criterion selected as objective function using the Irstea-HBAN procedure described by C. Michel} \usage{ Calibration_Michel(InputsModel, RunOptions, InputsCrit, CalibOptions, - FUN_MOD, FUN_CRIT, FUN_TRANSFO = NULL, quiet = FALSE) + FUN_MOD, FUN_CRIT, FUN_TRANSFO = NULL, verbose = TRUE) } \arguments{ \item{InputsModel}{[object of class \emph{InputsModel}] see \code{\link{CreateInputsModel}} for details} @@ -23,7 +21,7 @@ Calibration_Michel(InputsModel, RunOptions, InputsCrit, CalibOptions, \item{FUN_TRANSFO}{(optional) [function] model parameters transformation function, if the FUN_MOD used is native in the package FUN_TRANSFO is automatically defined} -\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE} +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} } \value{ [list] list containing the function outputs organised as follows: diff --git a/man/CreateCalibOptions.Rd b/man/CreateCalibOptions.Rd index e545dfaee6416052293669a7398a5ff32dd85422..085d3a06d3e6f62786085142862291bbb1ba0db8 100644 --- a/man/CreateCalibOptions.Rd +++ b/man/CreateCalibOptions.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/CreateCalibOptions.R \encoding{UTF-8} \name{CreateCalibOptions} \alias{CreateCalibOptions} diff --git a/man/CreateInputsCrit.Rd b/man/CreateInputsCrit.Rd index 02c79dd6bf79700b1bdee89f21c17ace314c9193..8467e8a63ec28471aa8252c92aef23154436da3e 100644 --- a/man/CreateInputsCrit.Rd +++ b/man/CreateInputsCrit.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/CreateInputsCrit.R \encoding{UTF-8} \name{CreateInputsCrit} \alias{CreateInputsCrit} diff --git a/man/CreateInputsModel.Rd b/man/CreateInputsModel.Rd index 4aebe122b4153e9574ef198c08a9c72b9b68a54b..3e5b11980932ccdbceeb2900d1a85dd7710958a7 100644 --- a/man/CreateInputsModel.Rd +++ b/man/CreateInputsModel.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/CreateInputsModel.R \encoding{UTF-8} \name{CreateInputsModel} \alias{CreateInputsModel} @@ -7,7 +5,7 @@ \usage{ CreateInputsModel(FUN_MOD, DatesR, Precip, PotEvap = NULL, TempMean = NULL, TempMin = NULL, TempMax = NULL, ZInputs = NULL, HypsoData = NULL, - NLayers = 5, quiet = FALSE) + NLayers = 5, verbose = TRUE) } \arguments{ \item{FUN_MOD}{[function] hydrological model function (e.g. RunModel_GR4J, RunModel_CemaNeigeGR4J)} @@ -18,11 +16,11 @@ CreateInputsModel(FUN_MOD, DatesR, Precip, PotEvap = NULL, TempMean = NULL, \item{PotEvap}{[numeric] time series of potential evapotranspiration (catchment average) [mm], required to create the GR model inputs} -\item{TempMean}{(optional) [numeric] time series of mean air temperature [degC], required to create the CemaNeige module inputs} +\item{TempMean}{(optional) [numeric] time series of mean air temperature [°C], required to create the CemaNeige module inputs} -\item{TempMin}{(optional) [numeric] time series of min air temperature [degC], possibly used to create the CemaNeige module inputs} +\item{TempMin}{(optional) [numeric] time series of min air temperature [°C], possibly used to create the CemaNeige module inputs} -\item{TempMax}{(optional) [numeric] time series of max air temperature [degC], possibly used to create the CemaNeige module inputs} +\item{TempMax}{(optional) [numeric] time series of max air temperature [°C], possibly used to create the CemaNeige module inputs} \item{ZInputs}{(optional) [numeric] real giving the mean elevation of the Precip and Temp series (before extrapolation) [m]} @@ -30,7 +28,7 @@ CreateInputsModel(FUN_MOD, DatesR, Precip, PotEvap = NULL, TempMean = NULL, \item{NLayers}{(optional) [numeric] integer giving the number of elevation layers requested [-], required to create the GR model inputs, default=5} -\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE} +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} } \value{ [list] object of class \emph{InputsModel} containing the data required to evaluate the model outputs; it can include the following: @@ -39,7 +37,7 @@ CreateInputsModel(FUN_MOD, DatesR, Precip, PotEvap = NULL, TempMean = NULL, \emph{$Precip } \tab [numeric] time series of total precipitation (catchment average) [mm] \cr \emph{$PotEvap } \tab [numeric] time series of potential evapotranspiration (catchment average) [mm], \cr\tab defined if FUN_MOD includes GR4H, GR4J, GR5J, GR6J, GR2M or GR1A \cr \cr \emph{$LayerPrecip } \tab [list] list of time series of precipitation (layer average) [mm], \cr\tab defined if FUN_MOD includes CemaNeige \cr \cr - \emph{$LayerTempMean } \tab [list] list of time series of mean air temperature (layer average) [degC], \cr\tab defined if FUN_MOD includes CemaNeige \cr \cr + \emph{$LayerTempMean } \tab [list] list of time series of mean air temperature (layer average) [°C], \cr\tab defined if FUN_MOD includes CemaNeige \cr \cr \emph{$LayerFracSolidPrecip} \tab [list] list of time series of solid precipitation fraction (layer average) [-], \cr\tab defined if FUN_MOD includes CemaNeige \cr \cr } } diff --git a/man/CreateRunOptions.Rd b/man/CreateRunOptions.Rd index 913bef1ad5acd1c22121d14034a1a801908edb35..b7dba5080e6f725a916b7e796b5c1e0e6645c702 100644 --- a/man/CreateRunOptions.Rd +++ b/man/CreateRunOptions.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/CreateRunOptions.R \encoding{UTF-8} \name{CreateRunOptions} \alias{CreateRunOptions} @@ -8,7 +6,7 @@ CreateRunOptions(FUN_MOD, InputsModel, IndPeriod_WarmUp = NULL, IndPeriod_Run, IniStates = NULL, IniResLevels = NULL, Outputs_Cal = NULL, Outputs_Sim = "all", RunSnowModule = TRUE, MeanAnSolidPrecip = NULL, - quiet = FALSE) + verbose = TRUE) } \arguments{ \item{FUN_MOD}{[function] hydrological model function (e.g. RunModel_GR4J, RunModel_CemaNeigeGR4J)} @@ -24,7 +22,7 @@ CreateRunOptions(FUN_MOD, InputsModel, IndPeriod_WarmUp = NULL, IndPeriod_Run, \item{IniResLevels}{(optional) [numeric] vector of initial filling rates for production and routing stores (2 values between 0 and 1) [-]} \item{Outputs_Cal}{(optional) [character] vector giving the outputs needed for the calibration \cr (e.g. c("Qsim")), the fewer outputs - the fastest the calibration} + the faster the calibration} \item{Outputs_Sim}{(optional) [character] vector giving the requested outputs \cr (e.g. c("DatesR","Qsim","SnowPack")), default="all"} @@ -32,7 +30,7 @@ CreateRunOptions(FUN_MOD, InputsModel, IndPeriod_WarmUp = NULL, IndPeriod_Run, \item{MeanAnSolidPrecip}{(optional) [numeric] vector giving the annual mean of average solid precipitation for each layer (computed from InputsModel if not defined) [mm/y]} -\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE} +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} } \value{ [list] object of class \emph{RunOptions} containing the data required to evaluate the model outputs; it can include the following: diff --git a/man/DataAltiExtrapolation_Valery.Rd b/man/DataAltiExtrapolation_Valery.Rd index 6a95b62a75738f4c6ae46ced7059ecffb55060cd..055e3cc773f87073177507bc2f087ab88a8432ac 100644 --- a/man/DataAltiExtrapolation_Valery.Rd +++ b/man/DataAltiExtrapolation_Valery.Rd @@ -1,23 +1,21 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/DataAltiExtrapolation_Valery.R \encoding{UTF-8} \name{DataAltiExtrapolation_Valery} \alias{DataAltiExtrapolation_Valery} \title{Altitudinal extrapolation of precipitation and temperature series described by A. Valéry} \usage{ DataAltiExtrapolation_Valery(DatesR, Precip, TempMean, TempMin = NULL, - TempMax = NULL, ZInputs, HypsoData, NLayers, quiet = FALSE) + TempMax = NULL, ZInputs, HypsoData, NLayers, verbose = TRUE) } \arguments{ \item{DatesR}{[POSIXlt] vector of dates} \item{Precip}{[numeric] time series of daily total precipitation (catchment average) [mm]} -\item{TempMean}{[numeric] time series of daily mean air temperature [degC]} +\item{TempMean}{[numeric] time series of daily mean air temperature [°C]} -\item{TempMin}{(optional) [numeric] time series of daily min air temperature [degC]} +\item{TempMin}{(optional) [numeric] time series of daily min air temperature [°C]} -\item{TempMax}{(optional) [numeric] time series of daily max air temperature [degC]} +\item{TempMax}{(optional) [numeric] time series of daily max air temperature [°C]} \item{ZInputs}{[numeric] real giving the mean elevation of the Precip and Temp series (before extrapolation) [m]} @@ -25,15 +23,15 @@ DataAltiExtrapolation_Valery(DatesR, Precip, TempMean, TempMin = NULL, \item{NLayers}{[numeric] integer giving the number of elevation layers requested [-]} -\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE} +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} } \value{ list containing the extrapolated series of precip. and air temp. on each elevation layer \tabular{ll}{ \emph{$LayerPrecip } \tab [list] list of time series of daily precipitation (layer average) [mm] \cr - \emph{$LayerTempMean } \tab [list] list of time series of daily mean air temperature (layer average) [degC] \cr - \emph{$LayerTempMin } \tab [list] list of time series of daily min air temperature (layer average) [degC] \cr - \emph{$LayerTempMax } \tab [list] list of time series of daily max air temperature (layer average) [degC] \cr + \emph{$LayerTempMean } \tab [list] list of time series of daily mean air temperature (layer average) [°C] \cr + \emph{$LayerTempMin } \tab [list] list of time series of daily min air temperature (layer average) [°C] \cr + \emph{$LayerTempMax } \tab [list] list of time series of daily max air temperature (layer average) [°C] \cr \emph{$LayerFracSolidPrecip} \tab [list] list of time series of daily solid precip. fract. (layer average) [-] \cr \emph{$ZLayers } \tab [numeric] vector of median elevation for each layer \cr } diff --git a/man/ErrorCrit.Rd b/man/ErrorCrit.Rd index b4070a345952ec41b7a504330923f81fca6d3d45..bc2994104bf5bd83367fdf7ad2e76a5705b06496 100644 --- a/man/ErrorCrit.Rd +++ b/man/ErrorCrit.Rd @@ -1,11 +1,9 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/ErrorCrit.R \encoding{UTF-8} \name{ErrorCrit} \alias{ErrorCrit} \title{Error criterion using the provided function} \usage{ -ErrorCrit(InputsCrit, OutputsModel, FUN_CRIT, quiet = FALSE) +ErrorCrit(InputsCrit, OutputsModel, FUN_CRIT, verbose = TRUE) } \arguments{ \item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details} @@ -14,7 +12,7 @@ ErrorCrit(InputsCrit, OutputsModel, FUN_CRIT, quiet = FALSE) \item{FUN_CRIT}{[function] error criterion function (e.g. ErrorCrit_RMSE, ErrorCrit_NSE)} -\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE} +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} } \value{ [list] list containing the function outputs, see \code{\link{ErrorCrit_RMSE}} or \code{\link{ErrorCrit_NSE}} for details diff --git a/man/ErrorCrit_KGE.Rd b/man/ErrorCrit_KGE.Rd index d4814b05b9b778932d645b5c74575237c895ed12..9cf7e460ffe7000ee7f747f660ebee69ee86866e 100644 --- a/man/ErrorCrit_KGE.Rd +++ b/man/ErrorCrit_KGE.Rd @@ -1,18 +1,16 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/ErrorCrit_KGE.R \encoding{UTF-8} \name{ErrorCrit_KGE} \alias{ErrorCrit_KGE} \title{Error criterion based on the KGE formula} \usage{ -ErrorCrit_KGE(InputsCrit, OutputsModel, quiet = FALSE) +ErrorCrit_KGE(InputsCrit, OutputsModel, verbose = TRUE) } \arguments{ \item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details} \item{OutputsModel}{[object of class \emph{OutputsModel}] see \code{\link{RunModel_GR4J}} or \code{\link{RunModel_CemaNeigeGR4J}} for details} -\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE} +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} } \value{ [list] list containing the function outputs organised as follows: @@ -20,7 +18,7 @@ ErrorCrit_KGE(InputsCrit, OutputsModel, quiet = FALSE) \emph{$CritValue } \tab [numeric] value of the criterion \cr \emph{$CritName } \tab [character] name of the criterion \cr \emph{$SubCritValues } \tab [numeric] values of the sub-criteria \cr - \emph{$SubCritNames } \tab [character] names of the sub-criteria \cr + \emph{$SubCritNames } \tab [character] names of the components of the criterion \cr \emph{$CritBestValue } \tab [numeric] theoretical best criterion value \cr \emph{$Multiplier } \tab [numeric] integer indicating whether the criterion is indeed an error (+1) or an efficiency (-1) \cr \emph{$Ind_notcomputed} \tab [numeric] indices of the time steps where InputsCrit$BoolCrit=FALSE or no data is available \cr @@ -31,8 +29,7 @@ Function which computes an error criterion based on the KGE formula proposed by } \details{ In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows -the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised -(e.g. Multiplier=+1 for RMSE, Multiplier=-1 for NSE). +the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised (Multiplier=-1 for KGE). } \examples{ ## see example of the ErrorCrit function diff --git a/man/ErrorCrit_KGE2.Rd b/man/ErrorCrit_KGE2.Rd index 4f01b674e3078fbac4f8c9a306336c87ee970f25..2c76f9fdd75a226ba1269d372d7951b653ff32fe 100644 --- a/man/ErrorCrit_KGE2.Rd +++ b/man/ErrorCrit_KGE2.Rd @@ -1,18 +1,16 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/ErrorCrit_KGE2.R \encoding{UTF-8} \name{ErrorCrit_KGE2} \alias{ErrorCrit_KGE2} \title{Error criterion based on the KGE' formula} \usage{ -ErrorCrit_KGE2(InputsCrit, OutputsModel, quiet = FALSE) +ErrorCrit_KGE2(InputsCrit, OutputsModel, verbose = TRUE) } \arguments{ \item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details} \item{OutputsModel}{[object of class \emph{OutputsModel}] see \code{\link{RunModel_GR4J}} or \code{\link{RunModel_CemaNeigeGR4J}} for details} -\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE} +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} } \value{ [list] list containing the function outputs organised as follows: @@ -20,7 +18,7 @@ ErrorCrit_KGE2(InputsCrit, OutputsModel, quiet = FALSE) \emph{$CritValue } \tab [numeric] value of the criterion \cr \emph{$CritName } \tab [character] name of the criterion \cr \emph{$SubCritValues } \tab [numeric] values of the sub-criteria \cr - \emph{$SubCritNames } \tab [character] names of the sub-criteria \cr + \emph{$SubCritNames } \tab [character] names of the components of the criterion \cr \emph{$CritBestValue } \tab [numeric] theoretical best criterion value \cr \emph{$Multiplier } \tab [numeric] integer indicating whether the criterion is indeed an error (+1) or an efficiency (-1) \cr \emph{$Ind_notcomputed} \tab [numeric] indices of the time steps where InputsCrit$BoolCrit=FALSE or no data is available \cr @@ -31,8 +29,7 @@ Function which computes an error criterion based on the KGE' formula proposed by } \details{ In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows -the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised -(e.g. Multiplier=+1 for RMSE, Multiplier=-1 for NSE). +the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised (Multiplier=-1 for KGE2). } \examples{ ## see example of the ErrorCrit function diff --git a/man/ErrorCrit_NSE.Rd b/man/ErrorCrit_NSE.Rd index a7a9a54aa9109e6ce2e44b896b41e816654f400a..9f5d67fbc17084dd3dcacf2689ecb534fc25f0af 100644 --- a/man/ErrorCrit_NSE.Rd +++ b/man/ErrorCrit_NSE.Rd @@ -1,18 +1,16 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/ErrorCrit_NSE.R \encoding{UTF-8} \name{ErrorCrit_NSE} \alias{ErrorCrit_NSE} \title{Error criterion based on the NSE formula} \usage{ -ErrorCrit_NSE(InputsCrit, OutputsModel, quiet = FALSE) +ErrorCrit_NSE(InputsCrit, OutputsModel, verbose = TRUE) } \arguments{ \item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details} \item{OutputsModel}{[object of class \emph{OutputsModel}] see \code{\link{RunModel_GR4J}} or \code{\link{RunModel_CemaNeigeGR4J}} for details} -\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE} +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} } \value{ [list] list containing the function outputs organised as follows: @@ -30,7 +28,7 @@ Function which computes an error criterion based on the NSE formula proposed by \details{ In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised -(e.g. Multiplier=+1 for RMSE, Multiplier=-1 for NSE). +(Multiplier=-1 for NSE). } \examples{ ## see example of the ErrorCrit function diff --git a/man/ErrorCrit_RMSE.Rd b/man/ErrorCrit_RMSE.Rd index 7c996fefe04a3695d818a2355b2a547e4c83c17a..9802a29cc2114c0443552e96e7eadff4733d4ffa 100644 --- a/man/ErrorCrit_RMSE.Rd +++ b/man/ErrorCrit_RMSE.Rd @@ -1,18 +1,16 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/ErrorCrit_RMSE.R \encoding{UTF-8} \name{ErrorCrit_RMSE} \alias{ErrorCrit_RMSE} \title{Error criterion based on the RMSE} \usage{ -ErrorCrit_RMSE(InputsCrit, OutputsModel, quiet = FALSE) +ErrorCrit_RMSE(InputsCrit, OutputsModel, verbose = TRUE) } \arguments{ \item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details} \item{OutputsModel}{[object of class \emph{OutputsModel}] see \code{\link{RunModel_GR4J}} or \code{\link{RunModel_CemaNeigeGR4J}} for details} -\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE} +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} } \value{ [list] list containing the function outputs organised as follows: @@ -30,7 +28,7 @@ Function which computes an error criterion based on the root mean square error ( \details{ In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised -(e.g. Multiplier=+1 for RMSE, Multiplier=-1 for NSE). +(Multiplier=+1 for RMSE). } \examples{ ## see example of the ErrorCrit function diff --git a/man/PEdaily_Oudin.Rd b/man/PEdaily_Oudin.Rd index c01f2984b2361af67ab17b00b3493869d95f26f1..5c77052b9121cbdab7280f0997bfa3260740ee65 100644 --- a/man/PEdaily_Oudin.Rd +++ b/man/PEdaily_Oudin.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/PEdaily_Oudin.R \encoding{UTF-8} \name{PEdaily_Oudin} \alias{PEdaily_Oudin} @@ -10,7 +8,7 @@ PEdaily_Oudin(JD, Temp, LatRad) \arguments{ \item{JD}{[numeric] time series of julian day [-]} -\item{Temp}{[numeric] time series of daily mean air temperature [degC]} +\item{Temp}{[numeric] time series of daily mean air temperature [°C]} \item{LatRad}{[numeric] latitude of measurement for the temperature series [rad]} } diff --git a/man/RunModel.Rd b/man/RunModel.Rd index c042c3ec91b873d4548bd1cd2a980837779dd848..5f19b724eb67c27368c1b2cb23329604ea1d8178 100644 --- a/man/RunModel.Rd +++ b/man/RunModel.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/RunModel.R \encoding{UTF-8} \name{RunModel} \alias{RunModel} diff --git a/man/RunModel_CemaNeige.Rd b/man/RunModel_CemaNeige.Rd index 9fe3d0c134830f800d70db82882ab4d1d6118456..da1a534c4455062263c81897732d09e84f78e35e 100644 --- a/man/RunModel_CemaNeige.Rd +++ b/man/RunModel_CemaNeige.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/RunModel_CemaNeige.R \encoding{UTF-8} \name{RunModel_CemaNeige} \alias{RunModel_CemaNeige} @@ -15,7 +13,7 @@ RunModel_CemaNeige(InputsModel, RunOptions, Param) \item{Param}{[numeric] vector of 2 parameters \tabular{ll}{ CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr -CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d] \cr +CemaNeige X2 \tab degree-day melt coefficient [mm/°C/d] \cr }} } \value{ @@ -26,12 +24,12 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d] \emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/d] \cr \emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/d] \cr \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack [mm] \cr - \emph{$CemaNeigeLayers[[iLayer]]$ThermalState } \tab [numeric] series of snow pack thermal state [degC] \cr + \emph{$CemaNeigeLayers[[iLayer]]$ThermalState } \tab [numeric] series of snow pack thermal state [°C] \cr \emph{$CemaNeigeLayers[[iLayer]]$Gratio } \tab [numeric] series of Gratio [0-1] \cr \emph{$CemaNeigeLayers[[iLayer]]$PotMelt } \tab [numeric] series of potential snow melt [mm] \cr \emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm] \cr \emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm] \cr - \emph{$StateEnd} \tab [numeric] states at the end of the run: CemaNeige states [mm & degC] \cr + \emph{$StateEnd} \tab [numeric] states at the end of the run: CemaNeige states [mm & °C] \cr } (refer to the provided references or to the package source code for further details on these model outputs) } diff --git a/man/RunModel_CemaNeigeGR4J.Rd b/man/RunModel_CemaNeigeGR4J.Rd index 038cff292729f4f6d04c891d90118fa69fc57045..56dada77c90f583f56b642712b536fde63edf20f 100644 --- a/man/RunModel_CemaNeigeGR4J.Rd +++ b/man/RunModel_CemaNeigeGR4J.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/RunModel_CemaNeigeGR4J.R \encoding{UTF-8} \name{RunModel_CemaNeigeGR4J} \alias{RunModel_CemaNeigeGR4J} @@ -19,7 +17,7 @@ GR4J X2 \tab intercatchment exchange coefficient [mm/d] GR4J X3 \tab routing store capacity [mm] \cr GR4J X4 \tab unit hydrograph time constant [d] \cr CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr -CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d] \cr +CemaNeige X2 \tab degree-day melt coefficient [mm/°C/d] \cr }} } \value{ @@ -44,12 +42,12 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d] \emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/d] \cr \emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/d] \cr \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack [mm] \cr - \emph{$CemaNeigeLayers[[iLayer]]$ThermalState } \tab [numeric] series of snow pack thermal state [degC] \cr + \emph{$CemaNeigeLayers[[iLayer]]$ThermalState } \tab [numeric] series of snow pack thermal state [°C] \cr \emph{$CemaNeigeLayers[[iLayer]]$Gratio } \tab [numeric] series of Gratio [0-1] \cr \emph{$CemaNeigeLayers[[iLayer]]$PotMelt } \tab [numeric] series of potential snow melt [mm/d] \cr \emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/d] \cr \emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/d] \cr - \emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab res. & UH levels [mm], CemaNeige states [mm & degC] \cr + \emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab store & unit hydrographs levels [mm], CemaNeige states [mm & °C] \cr } (refer to the provided references or to the package source code for further details on these model outputs) } diff --git a/man/RunModel_CemaNeigeGR5J.Rd b/man/RunModel_CemaNeigeGR5J.Rd index 5a169773c1d2c560e03316522dc84f058940a13f..de92a255e9a9b60d3fd950227e6ea5708691eb92 100644 --- a/man/RunModel_CemaNeigeGR5J.Rd +++ b/man/RunModel_CemaNeigeGR5J.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/RunModel_CemaNeigeGR5J.R \encoding{UTF-8} \name{RunModel_CemaNeigeGR5J} \alias{RunModel_CemaNeigeGR5J} @@ -20,7 +18,7 @@ GR5J X3 \tab routing store capacity [mm] GR5J X4 \tab unit hydrograph time constant [d] \cr GR5J X5 \tab intercatchment exchange threshold [-] \cr CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr -CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d] \cr +CemaNeige X2 \tab degree-day melt coefficient [mm/°C/d] \cr }} } \value{ @@ -45,12 +43,12 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d] \emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/d] \cr \emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/d] \cr \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack [mm] \cr - \emph{$CemaNeigeLayers[[iLayer]]$ThermalState } \tab [numeric] series of snow pack thermal state [degC] \cr + \emph{$CemaNeigeLayers[[iLayer]]$ThermalState } \tab [numeric] series of snow pack thermal state [°C] \cr \emph{$CemaNeigeLayers[[iLayer]]$Gratio } \tab [numeric] series of Gratio [0-1] \cr \emph{$CemaNeigeLayers[[iLayer]]$PotMelt } \tab [numeric] series of potential snow melt [mm/d] \cr \emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/d] \cr \emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/d] \cr - \emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab res. & UH levels [mm], CemaNeige states [mm & degC] \cr + \emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab store & unit hydrographs levels [mm], CemaNeige states [mm & °C] \cr } (refer to the provided references or to the package source code for further details on these model outputs) } diff --git a/man/RunModel_CemaNeigeGR6J.Rd b/man/RunModel_CemaNeigeGR6J.Rd index d8a3b095bad38c9bd6533632d24edae2cce0fe7e..f9327e77ab7260af9f6798841772db32887ae4ff 100644 --- a/man/RunModel_CemaNeigeGR6J.Rd +++ b/man/RunModel_CemaNeigeGR6J.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/RunModel_CemaNeigeGR6J.R \encoding{UTF-8} \name{RunModel_CemaNeigeGR6J} \alias{RunModel_CemaNeigeGR6J} @@ -21,7 +19,7 @@ GR6J X4 \tab unit hydrograph time constant [d] GR6J X5 \tab intercatchment exchange threshold [-] \cr GR6J X6 \tab coefficient for emptying exponential store [mm] \cr CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr -CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d] \cr +CemaNeige X2 \tab degree-day melt coefficient [mm/°C/d] \cr }} } \value{ @@ -48,12 +46,12 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d] \emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/d] \cr \emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/d] \cr \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack [mm] \cr - \emph{$CemaNeigeLayers[[iLayer]]$ThermalState } \tab [numeric] series of snow pack thermal state [degC] \cr + \emph{$CemaNeigeLayers[[iLayer]]$ThermalState } \tab [numeric] series of snow pack thermal state [°C] \cr \emph{$CemaNeigeLayers[[iLayer]]$Gratio } \tab [numeric] series of Gratio [0-1] \cr \emph{$CemaNeigeLayers[[iLayer]]$PotMelt } \tab [numeric] series of potential snow melt [mm/d] \cr \emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/d] \cr \emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/d] \cr - \emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab res. & UH levels [mm], CemaNeige states [mm & degC] \cr + \emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab store & unit hydrographs levels [mm], CemaNeige states [mm & °C] \cr } (refer to the provided references or to the package source code for further details on these model outputs) } diff --git a/man/RunModel_GR1A.Rd b/man/RunModel_GR1A.Rd index 29593df9ed6142dc7877e22b77fa338992f7986d..9b44d33c83aa8834935419ebecc0d933a5b24214 100644 --- a/man/RunModel_GR1A.Rd +++ b/man/RunModel_GR1A.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/RunModel_GR1A.R \encoding{UTF-8} \name{RunModel_GR1A} \alias{RunModel_GR1A} diff --git a/man/RunModel_GR2M.Rd b/man/RunModel_GR2M.Rd index 194f35d14b443181ff198d1d60eb26a83013341d..e551d1b059966f03241cfcf2a13615f90ecc7b88 100644 --- a/man/RunModel_GR2M.Rd +++ b/man/RunModel_GR2M.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/RunModel_GR2M.R \encoding{UTF-8} \name{RunModel_GR2M} \alias{RunModel_GR2M} diff --git a/man/RunModel_GR4H.Rd b/man/RunModel_GR4H.Rd index 4c78262f6856d61986cdeb03f29639c5d1431514..e24d6c57122a7d4620fff66e86ade5d752146b02 100644 --- a/man/RunModel_GR4H.Rd +++ b/man/RunModel_GR4H.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/RunModel_GR4H.R \encoding{UTF-8} \name{RunModel_GR4H} \alias{RunModel_GR4H} diff --git a/man/RunModel_GR4J.Rd b/man/RunModel_GR4J.Rd index 4f892436cd0facc219bfc9ba49d9b3350b2f662e..07966bdbcb360b46c409145d8424e3fd00c07dcc 100644 --- a/man/RunModel_GR4J.Rd +++ b/man/RunModel_GR4J.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/RunModel_GR4J.R \encoding{UTF-8} \name{RunModel_GR4J} \alias{RunModel_GR4J} diff --git a/man/RunModel_GR5J.Rd b/man/RunModel_GR5J.Rd index 7e9fe58a30737a1214f8b02dfb333cd2878a410c..03565663d5c8aae5f587f212b87c4e0cd3dc6f7d 100644 --- a/man/RunModel_GR5J.Rd +++ b/man/RunModel_GR5J.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/RunModel_GR5J.R \encoding{UTF-8} \name{RunModel_GR5J} \alias{RunModel_GR5J} diff --git a/man/RunModel_GR6J.Rd b/man/RunModel_GR6J.Rd index c342bf05f850d91be3cc06d67605a89a21b0284c..d20806de70efbddf35404e37335ce1875caeadb0 100644 --- a/man/RunModel_GR6J.Rd +++ b/man/RunModel_GR6J.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/RunModel_GR6J.R \encoding{UTF-8} \name{RunModel_GR6J} \alias{RunModel_GR6J} diff --git a/man/SeriesAggreg.Rd b/man/SeriesAggreg.Rd index 908eb422537db949b64d6fc9184f5a08a2464a21..336981e6113428ed9bb412964d34c1eb016d37b4 100644 --- a/man/SeriesAggreg.Rd +++ b/man/SeriesAggreg.Rd @@ -1,12 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/SeriesAggreg.R \encoding{UTF-8} \name{SeriesAggreg} \alias{SeriesAggreg} \title{Conversion of time series to another time step (aggregation only)} \usage{ SeriesAggreg(TabSeries, TimeFormat, NewTimeFormat, ConvertFun, - YearFirstMonth = 1, quiet = FALSE) + YearFirstMonth = 1, verbose = TRUE) } \arguments{ \item{TabSeries}{[POSIXlt+numeric] dataframe containing the vector of dates and the time series values} @@ -19,7 +17,7 @@ SeriesAggreg(TabSeries, TimeFormat, NewTimeFormat, ConvertFun, \item{YearFirstMonth}{(optional) [numeric] integer used when NewTimeFormat = "yearly" to set when the starting month of the year (e.g. 01 for calendar year or 09 for hydrological year starting in september)} -\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default = FALSE} +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default = FALSE} } \value{ [POSIXlt+numeric] dataframe containing a vector of aggregated dates and time series values diff --git a/man/TransfoParam.Rd b/man/TransfoParam.Rd index 941c0ea7cb9b78a35dfe6a129a7073a5e1453827..34e278351bc58fb1041d6ee054897fde96f79d81 100644 --- a/man/TransfoParam.Rd +++ b/man/TransfoParam.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/TransfoParam.R \encoding{UTF-8} \name{TransfoParam} \alias{TransfoParam} diff --git a/man/TransfoParam_CemaNeige.Rd b/man/TransfoParam_CemaNeige.Rd index 76621958ea55f99e9290c9bf381594b12f55da0e..0f556a152ba9149b4258a9a44884613cf87a08b1 100644 --- a/man/TransfoParam_CemaNeige.Rd +++ b/man/TransfoParam_CemaNeige.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/TransfoParam_CemaNeige.R \encoding{UTF-8} \name{TransfoParam_CemaNeige} \alias{TransfoParam_CemaNeige} diff --git a/man/TransfoParam_GR1A.Rd b/man/TransfoParam_GR1A.Rd index 21b6bc3181d35304411f1b5f35741b4f39724ab8..d82f7a0120bc5ad6f7595717d893704098bdf66b 100644 --- a/man/TransfoParam_GR1A.Rd +++ b/man/TransfoParam_GR1A.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/TransfoParam_GR1A.R \encoding{UTF-8} \name{TransfoParam_GR1A} \alias{TransfoParam_GR1A} diff --git a/man/TransfoParam_GR2M.Rd b/man/TransfoParam_GR2M.Rd index 34c8af2f91abf7c79bc485e4981dbb0648064d01..b8905e79a46e0cff5f1f73ab1fd8cfbc2a91098f 100644 --- a/man/TransfoParam_GR2M.Rd +++ b/man/TransfoParam_GR2M.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/TransfoParam_GR2M.R \encoding{UTF-8} \name{TransfoParam_GR2M} \alias{TransfoParam_GR2M} diff --git a/man/TransfoParam_GR4H.Rd b/man/TransfoParam_GR4H.Rd index 5ee312676c3f768b27042760c58cec4bb10bc9c9..6d735c1cebdca83953e694bed9ef20b64ec49844 100644 --- a/man/TransfoParam_GR4H.Rd +++ b/man/TransfoParam_GR4H.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/TransfoParam_GR4H.R \encoding{UTF-8} \name{TransfoParam_GR4H} \alias{TransfoParam_GR4H} diff --git a/man/TransfoParam_GR4J.Rd b/man/TransfoParam_GR4J.Rd index 1c6617fc7faa7ab3a6ad85cd4f9b88bd70c6bf11..9b537ca26634259e5db4a493cb60744384a684a7 100644 --- a/man/TransfoParam_GR4J.Rd +++ b/man/TransfoParam_GR4J.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/TransfoParam_GR4J.R \encoding{UTF-8} \name{TransfoParam_GR4J} \alias{TransfoParam_GR4J} diff --git a/man/TransfoParam_GR5J.Rd b/man/TransfoParam_GR5J.Rd index d0977b61c6cd0508675585ef8ca175357f1dd7f9..1c710242f42d656b214239cab99e35a49be157df 100644 --- a/man/TransfoParam_GR5J.Rd +++ b/man/TransfoParam_GR5J.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/TransfoParam_GR5J.R \encoding{UTF-8} \name{TransfoParam_GR5J} \alias{TransfoParam_GR5J} diff --git a/man/TransfoParam_GR6J.Rd b/man/TransfoParam_GR6J.Rd index cc9a490e1f3b710bad74d3f8afc7c48d4adc54c5..dc2f294b9e612bb98b499470ad328602cdf5416b 100644 --- a/man/TransfoParam_GR6J.Rd +++ b/man/TransfoParam_GR6J.Rd @@ -1,5 +1,3 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/TransfoParam_GR6J.R \encoding{UTF-8} \name{TransfoParam_GR6J} \alias{TransfoParam_GR6J} diff --git a/man/plot_OutputsModel.Rd b/man/plot_OutputsModel.Rd index f4089950eca5b1364b7cfd969740f9942216787f..8f3289cb90a785aded62fe452f98870ef33b12ea 100644 --- a/man/plot_OutputsModel.Rd +++ b/man/plot_OutputsModel.Rd @@ -1,12 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/plot_OutputsModel.R \encoding{UTF-8} \name{plot_OutputsModel} \alias{plot_OutputsModel} \title{Default preview of model outputs} \usage{ plot_OutputsModel(OutputsModel, Qobs = NULL, IndPeriod_Plot = NULL, - BasinArea = NULL, PlotChoice = "all", quiet = FALSE) + BasinArea = NULL, PlotChoice = "all", verbose = TRUE) } \arguments{ \item{OutputsModel}{[object of class \emph{OutputsModel}] list of model outputs (which must at least include DatesR, Precip and Qsim) [POSIXlt, mm, mm]} @@ -19,7 +17,7 @@ plot_OutputsModel(OutputsModel, Qobs = NULL, IndPeriod_Plot = NULL, \item{PlotChoice}{(optional) [character] choice of plots \cr (e.g. c("Precip", "SnowPack", "Flows", "Regime", "CumFreq", "CorQQ")), default="all"} -\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE} +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} } \value{ screen plot window