diff --git a/man/CreateInputsModel.Rd b/man/CreateInputsModel.Rd index 856014a8a825cdf2bb548614e5e2a1448a71f31e..463ccaddc16c00597da3ab28da0ede0771af09e5 100644 --- a/man/CreateInputsModel.Rd +++ b/man/CreateInputsModel.Rd @@ -28,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 CemaNeige module inputs, default=5} -\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} +\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default= \code{TRUE}} } \value{ [list] object of class \emph{InputsModel} containing the data required to evaluate the model outputs; it can include the following: @@ -36,16 +36,16 @@ CreateInputsModel(FUN_MOD, DatesR, Precip, PotEvap = NULL, TempMean = NULL, \emph{$DatesR } \tab [POSIXlt] vector of dates \cr \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) [°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 + \emph{$LayerPrecip } \tab [list] list of time series of precipitation (layer average) [mm], \cr\tab defined if \code{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 \code{FUN_MOD} includes CemaNeige \cr \cr + \emph{$LayerFracSolidPrecip} \tab [list] list of time series of solid precipitation fraction (layer average) [-], \cr\tab defined if \code{FUN_MOD} includes CemaNeige \cr \cr } } \description{ Creation of the InputsModel object required to the RunModel functions. } \details{ -Users wanting to use FUN_MOD functions that are not included in +Users wanting to use \code{FUN_MOD} functions that are not included in the package must create their own InputsModel object accordingly. } \examples{