From 6f7b6155b7a0e88f944ee1e8d0da26d8114b724f Mon Sep 17 00:00:00 2001
From: Delaigue Olivier <olivier.delaigue@irstea.priv>
Date: Tue, 29 Jan 2019 09:15:37 +0100
Subject: [PATCH] v1.1.2.34 CLEAN: add explanations about Julian day in
PEdaily_Oudin doc
---
DESCRIPTION | 2 +-
NEWS.rmd | 2 +-
man/PEdaily_Oudin.Rd | 8 ++++++--
3 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/DESCRIPTION b/DESCRIPTION
index a18cad10..13771a3c 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,7 +1,7 @@
Package: airGR
Type: Package
Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.1.2.3
+Version: 1.1.2.34
Date: 2019-01-29
Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),
diff --git a/NEWS.rmd b/NEWS.rmd
index c051d8f7..fed20979 100644
--- a/NEWS.rmd
+++ b/NEWS.rmd
@@ -13,7 +13,7 @@ output:
-### 1.1.2.33 Release Notes (2019-01-29)
+### 1.1.2.34 Release Notes (2019-01-29)
diff --git a/man/PEdaily_Oudin.Rd b/man/PEdaily_Oudin.Rd
index 3a07f303..67a6c9d4 100644
--- a/man/PEdaily_Oudin.Rd
+++ b/man/PEdaily_Oudin.Rd
@@ -14,7 +14,7 @@ PEdaily_Oudin(JD, Temp, LatRad, Lat, LatUnit)
\arguments{
-\item{JD}{[numeric] time series of julian day [-]}
+\item{JD}{[numeric] time series of Julian day of the year [-]; see details below}
\item{Temp}{[numeric] time series of daily mean air temperature [°C]}
@@ -35,11 +35,15 @@ PEdaily_Oudin(JD, Temp, LatRad, Lat, LatUnit)
Function which computes daily PE using the formula from Oudin et al. (2005).
}
+\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}).
+}
\examples{
library(airGR)
data(L0123001)
-PotEvap <- PEdaily_Oudin(JD = as.POSIXlt(BasinObs$DatesR)$yday, Temp = BasinObs$T,
+PotEvap <- PEdaily_Oudin(JD = as.POSIXlt(BasinObs$DatesR)$yday + 1,
+ Temp = BasinObs$T,
Lat = 0.8, LatUnit = "rad")
}
--
GitLab