v1.0.9.74 revision of units in documentation (mm or mm/time step)

DESCRIPTION

 Package: airGR
 Type: Package
 Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.0.9.73
-Date: 2018-01-30
+Version: 1.0.9.74
+Date: 2018-02-01
 Authors@R: c(
   person("Laurent", "Coron", role = c("aut", "trl")),
   person("Charles", "Perrin", role = c("aut", "ths")),

NEWS.rmd

@@ -14,7 +14,7 @@ output:
 
 
 
-### 1.0.9.67 Release Notes (2017-11-16) 
+### 1.0.9.74 Release Notes (2018-02-01) 
 
 
 ____________________________________________________________________________________

man/CreateInputsModel.Rd

@@ -20,11 +20,11 @@ CreateInputsModel(FUN_MOD, DatesR, Precip, PrecipScale = TRUE, PotEvap = NULL,
 
 \item{DatesR}{[POSIXt] vector of dates required to create the GR model and CemaNeige module inputs}
 
-\item{Precip}{[numeric] time series of total precipitation (catchment average) [mm], required to create the GR model and CemaNeige module inputs}
+\item{Precip}{[numeric] time series of total precipitation (catchment average) [mm/time step], required to create the GR model and CemaNeige module inputs}
 
 \item{PrecipScale}{(optional) [boolean] indicating if the mean of the precipitation interpolated on the elevation layers must be kept or not, required to create CemaNeige module inputs, default = \code{TRUE} (the mean of the precipitation is kept to the original value)}
 
-\item{PotEvap}{[numeric] time series of potential evapotranspiration (catchment average) [mm], required to create the GR model inputs}
+\item{PotEvap}{[numeric] time series of potential evapotranspiration (catchment average) [mm/time step], required to create the GR model inputs}
 
 \item{TempMean}{(optional) [numeric] time series of mean air temperature [°C], required to create the CemaNeige module inputs}
 
@@ -46,9 +46,9 @@ CreateInputsModel(FUN_MOD, DatesR, Precip, PrecipScale = TRUE, PotEvap = NULL,
 [list] object of class \emph{InputsModel} containing the data required to evaluate the model outputs; it can include the following:
          \tabular{ll}{
          \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  \code{FUN_MOD} includes CemaNeige \cr \cr
+         \emph{$Precip              }  \tab   [numeric] time series of total precipitation (catchment average) [mm/time step] \cr
+         \emph{$PotEvap             }  \tab   [numeric] time series of potential evapotranspiration (catchment average) [mm/time step], \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/time step], \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
          }

man/DataAltiExtrapolation_Valery.Rd

@@ -18,7 +18,7 @@ DataAltiExtrapolation_Valery(DatesR, Precip, PrecipScale = TRUE,
 \arguments{
 \item{DatesR}{[POSIXt] vector of dates}
 
-\item{Precip}{[numeric] time series of daily total precipitation (catchment average) [mm]}
+\item{Precip}{[numeric] time series of daily total precipitation (catchment average) [mm/d]}
 
 \item{PrecipScale}{(optional) [boolean] indicating if the mean of the precipitation interpolated on the elevation layers must be kept or not, required to create CemaNeige module inputs, default = \code{TRUE} (the mean of the precipitation is kept to the original value)}
 
@@ -39,7 +39,7 @@ DataAltiExtrapolation_Valery(DatesR, Precip, PrecipScale = 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{$LayerPrecip         }  \tab  [list] list of time series of daily precipitation (layer average) [mm/d]        \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

man/RunModel_CemaNeige.Rd

@@ -36,9 +36,9 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/°C/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 [°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{$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{$CemaNeigeLayers[[iLayer]]$Temp         }   \tab [numeric] series of air temperature [°C] \cr
          \emph{$StateEnd}                                  \tab [numeric] states at the end of the run: CemaNeige states [mm & °C], \cr\tab see \code{\link{CreateIniStates}} for more details \cr
          }                                                                                                     

man/SeriesAggreg.Rd

@@ -21,7 +21,7 @@ SeriesAggreg(TabSeries, TimeFormat, NewTimeFormat, ConvertFun,
 
 \item{NewTimeFormat}{[character] desired format (i.e. \code{"hourly"}, \code{"daily"}, \code{"monthly"} or \code{"yearly"})}
 
-\item{ConvertFun}{[character] names of aggregation functions (e.g. for P[mm], T[deg], Q[mm] : \code{ConvertFun = c("sum", "mean", "sum"}))}
+\item{ConvertFun}{[character] names of aggregation functions (e.g. for P[mm], T[degC], Q[mm] : \code{ConvertFun = c("sum", "mean", "sum"}))}
 
 \item{YearFirstMonth}{(optional) [numeric] integer used when \code{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)}