From 6021c3a64659f3b1694b5e5db1ae2b97df794bea Mon Sep 17 00:00:00 2001
From: Delaigue Olivier <olivier.delaigue@irstea.priv>
Date: Thu, 23 May 2019 14:26:00 +0200
Subject: [PATCH] v1.3.2.7 DOC: PE_Oudin doc revised
---
DESCRIPTION | 4 ++--
NEWS.rmd | 2 +-
man/PE_Oudin.Rd | 24 +++++++++++++++---------
3 files changed, 18 insertions(+), 12 deletions(-)
diff --git a/DESCRIPTION b/DESCRIPTION
index 43ce4585..d2c5fa08 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,8 +1,8 @@
Package: airGR
Type: Package
Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.3.2.6
-Date: 2019-05-22
+Version: 1.3.2.7
+Date: 2019-05-23
Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),
person("Olivier", "Delaigue", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-7668-8468"), email = "airGR@irstea.fr"),
diff --git a/NEWS.rmd b/NEWS.rmd
index 8a92b5b5..2789188e 100644
--- a/NEWS.rmd
+++ b/NEWS.rmd
@@ -14,7 +14,7 @@ output:
-### 1.3.2.6 Release Notes (2019-05-22)
+### 1.3.2.7 Release Notes (2019-05-22)
#### New features
diff --git a/man/PE_Oudin.Rd b/man/PE_Oudin.Rd
index 1ea8bc74..94805f19 100644
--- a/man/PE_Oudin.Rd
+++ b/man/PE_Oudin.Rd
@@ -5,7 +5,7 @@
\alias{PE_Oudin}
-\title{Computation of daily our hourly series of potential evapotranspiration with Oudin's formula}
+\title{Computation of series of potential evapotranspiration at the daily or hourly time steps with Oudin's formula}
\usage{
@@ -14,19 +14,19 @@ PE_Oudin(JD, Temp, LatRad, Lat, LatUnit, TimeStepIn = "daily", TimeStepOut = "da
\arguments{
-\item{JD}{[numeric] time series of Julian day of the year [-]; see details below}
+\item{JD}{[numeric] time series of Julian day of the year [-]; see details}
\item{Temp}{[numeric] time series of daily (or hourly) mean air temperature [°C]}
-\item{LatRad}{(deprecated)[numeric] latitude of measurement for the temperature series [rad]. Please use \code{Lat} instead}
+\item{LatRad}{(deprecated)[numeric] latitude of measurement for the temperature series [radians]. Please use \code{Lat} instead}
-\item{Lat}{[numeric] latitude of measurement for the temperature series [radian or degrees]}
+\item{Lat}{[numeric] latitude of measurement for the temperature series [radians or degrees]}
\item{LatUnit}{[character] latitude unit (default = \code{"rad"} or \code{"deg"})}
-\item{TimeStepIn}{[character] time step of inputs (default = \code{"daily"} or \code{"hourly"})}
+\item{TimeStepIn}{[character] time step of inputs (e.g. \code{"daily"} or \code{"hourly"}, default = \code{"daily"})}
-\item{TimeStepOut}{[character] time step of outputs (default = \code{"daily"} or \code{"hourly"})}
+\item{TimeStepOut}{[character] time step of outputs (e.g. \code{"daily"} or \code{"hourly"}, default = \code{"daily"})}
}
@@ -36,13 +36,19 @@ PE_Oudin(JD, Temp, LatRad, Lat, LatUnit, TimeStepIn = "daily", TimeStepOut = "da
\description{
-Function which computes daily PE using the formula from Oudin et al. (2005).
-From daily to hourly time steps, the PE is disaggregated as explained by Lobligeois (2014; p. 78)
+Function which computes PE using the formula from Oudin et al. (2005). PE can be computed at the daily time step from hourly or daily temperature and at the hourly time step with hourly or daily temperature through a disaggregation of daily PE (see details).
}
\details{
In the \code{JD} argument, the Julian day of the year of the 1st of January is equal to 1 and the 31st of December to 365 (366 in leap years)). If the Julian day of the year is computed on an object of the \code{POSIXlt} class, the user has to add 1 to the returned value (e.g. \code{as.POSIXlt("2016-12-31")$yday + 1}).
-For hourly temperature, 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 days must have 24 identical Julian day values (one for each hour).
+
+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)
}
\examples{
--
GitLab