v1.3.2.10 DOC: PE_Oudin doc cleaned and Pedaily_Oudin is now n alias

DESCRIPTION

 Package: airGR
 Type: Package
 Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.3.2.9
+Version: 1.3.2.10
 Date: 2019-05-23
 Authors@R: c(
   person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),

NEWS.rmd

@@ -14,7 +14,7 @@ output:
 
 
 
-### 1.3.2.9 Release Notes (2019-05-23)
+### 1.3.2.10 Release Notes (2019-05-23)
 
 
 #### New features

man/PE_Oudin.Rd

@@ -3,13 +3,18 @@
 
 \name{PE_Oudin}
 \alias{PE_Oudin}
+\alias{PEdaily_Oudin}
 
 
 \title{Computation of series of potential evapotranspiration at the daily or hourly time steps with Oudin's formula}
 
 
 \usage{
-PE_Oudin(JD, Temp, LatRad, Lat, LatUnit, TimeStepIn = "daily", TimeStepOut = "daily")
+PE_Oudin(JD, Temp, LatRad, Lat, LatUnit,
+         TimeStepIn = "daily", TimeStepOut = "daily")
+
+## deprectated function
+PEdaily_Oudin(JD, Temp, LatRad, Lat, LatUnit)
 }
 
 
@@ -45,10 +50,14 @@ In the \code{JD} argument, the Julian day of the year of the 1st of January is e
 When hourly temperature is provided, all the values of the same day have to be set to the same Julian day of the year (e.g. \code{as.POSIXlt("2016-12-31 00:00:00")$yday + 1} and \code{as.POSIXlt("2016-12-31 00:01:00")$yday + 1}). Each single day must be provided 24 identical Julian day values (one for each hour).
 
 Four cases are possible:
-- TimeStepIn = "daily" and TimeStepOut = "daily": this is the classical application of the Oudin et al. (2005) formula
-- TimeStepIn = "daily" and TimeStepOut = "hourly": the daily temperature is used inside the \code{PE_Oudin} function to calculate daily PE, which is then disaggregated at the hourly time step with use of a sinusoidal function (see Lobligeois, 2014, p. 78)
-- TimeStepIn = "hourly" and TimeStepOut = "daily": the hourly temperature is aggregated at the daily time step and the daily PE is calculated normally within \code{PE_Oudin}
-- TimeStepIn = "hourly" and TimeStepOut = "hourly": the hourly temperature is aggregated at the daily time step, the daily PE is then calculated normally within \code{PE_Oudin}, which is finally disaggregated at the hourly time step with use of a sinusoidal function (see Lobligeois, 2014, p. 78)
+\itemize{
+\item \code{TimeStepIn = "daily"} and \code{TimeStepOut = "daily"}: this is the classical application of the Oudin et al. (2005) formula
+\item \code{TimeStepIn = "daily"} and \code{TimeStepOut = "hourly"}: the daily temperature is used inside the \code{PE_Oudin} function to calculate daily PE, which is then disaggregated at the hourly time step with use of a sinusoidal function (see Lobligeois, 2014, p. 78)
+\item \code{TimeStepIn = "hourly"} and \code{TimeStepOut = "daily"}: the hourly temperature is aggregated at the daily time step and the daily PE is calculated normally within \code{PE_Oudin}
+\item \code{TimeStepIn = "hourly"} and \code{TimeStepOut = "hourly"}: the hourly temperature is aggregated at the daily time step, the daily PE is then calculated normally within \code{PE_Oudin}, which is finally disaggregated at the hourly time step with use of a sinusoidal function (see Lobligeois, 2014, p. 78)
+}
+
+The use of the \code{PEdaily_Oudin} corresponds to the first case of the use of \code{PE_Oudin}.
 }
 
 \examples{
@@ -70,6 +79,7 @@ Oudin, L., F. Hervieu, C. Michel, C. Perrin, V. Andréassian, F. Anctil and C. L
   Which potential evapotranspiration input for a lumped rainfall-runoff model?: 
   Part 2-Towards a simple and efficient potential evapotranspiration model for rainfall-runoff modelling. 
   Journal of Hydrology, 303(1-4), 290-306. doi:10.1016/j.jhydrol.2004.08.026.
+\cr\cr
 Lobligeois, F. (2014).
   Mieux connaitre la distribution spatiale des pluies améliore-t-il la modélisation des crues ? Diagnostic sur 181 bassins versants français.
   PhD thesis (in French), AgroParisTech (Paris), IRSTEA (Antony), France.