v0.1.9.24 revisions of ObsGR documentation

DESCRIPTION

 Package: airGRteaching
 Type: Package
 Title: Tools to Simplify the Use of the airGR Hydrological Package for Education (Including a Shiny Interface)
-Version: 0.1.9.23
+Version: 0.1.9.24
 Date: 2018-01-29
 Authors@R: c(person("Olivier", "Delaigue", role = c("aut", "cre"), email = "airGR@irstea.fr"), person("Laurent", "Coron", role = c("aut")), person("Pierre", "Brigode", role = c("aut")), person("Guillaume", "Thirel", role = c("ctb")))
 Depends: airGR (>= 1.0.9.43)

man/ObsGR.Rd

 \encoding{UTF-8}
 \name{ObsGR}
 \alias{ObsGR}
-\title{Creation of the inputs required for the CalGR and SimGR functions}
+\title{Creation of the inputs required to run the CalGR and SimGR functions}
 
 
 \usage{
@@ -15,9 +15,9 @@ ObsGR(ObsBV = NULL, DatesR = NULL, Precip = NULL, PotEvap = NULL,
 \arguments{
   \item{ObsBV}{(optional) [data.frame] data.frame of dates, total precipitation, potential evapotranspiration, observed discharges and mean air temperature (only if CemaNeige is used) (variables must be in this order; see below for the units)}
   
-  \item{DatesR}{(optional) [POSIXt] vector of dates required to create the GR and CemaNeige models inputs. Time zone must be defined as "UTC"}
+  \item{DatesR}{(optional) [POSIXt] vector of dates required to create the GR and CemaNeige (if used) models inputs. Time zone must be defined as "UTC"}
   
-  \item{Precip}{(optional) [numeric] time series of total precipitation (catchment average) [mm], required to create the GR and CemaNeige models inputs}
+  \item{Precip}{(optional) [numeric] time series of total precipitation (catchment average) [mm], required to create the GR and CemaNeige (if used) models inputs}
   
   \item{PotEvap}{(optional) [numeric] time series of potential evapotranspiration (catchment average) [mm], required to create the GR model inputs}
   
@@ -25,11 +25,11 @@ ObsGR(ObsBV = NULL, DatesR = NULL, Precip = NULL, PotEvap = NULL,
   
   \item{TempMean}{(optional) [numeric] time series of mean air temperature [°C], required to create the CemaNeige model inputs}
   
-  \item{ZInputs}{(optional) [numeric] real giving the mean elevation of the Precip and TempMean series (before extrapolation) [m], possibly used to create the CemaNeige model inputs}
+  \item{ZInputs}{(optional) [numeric] real giving the mean elevation of the Precip and TempMean series (before extrapolation) [m], possibly used to create the CemaNeige (if used) model inputs}
   
-  \item{HypsoData}{(optional) [numeric] vector of 101 reals: min, q01 to q99 and max of catchment elevation distribution [m]; if not defined a single elevation is used for CemaNeige}
+  \item{HypsoData}{(optional) [numeric] vector of 101 reals: min, q01 to q99 and max of catchment elevation distribution [m]; if not defined a single elevation is used for CemaNeige (if used)}
   
-  \item{NLayers}{(optional) [numeric] integer giving the number of elevation layers requested [-], required to create CemaNeige model inputs}
+  \item{NLayers}{(optional) [numeric] integer giving the number of elevation layers requested [-], required to create CemaNeige (if used) model inputs}
   
   \item{HydroModel}{[character] name of the hydrological model (must be one of \code{"GR1A"}, \code{"GR2M"}, \code{"GR4J"}, \code{"GR5J"}, \code{"GR6J"} or \code{"GR4H"})}
   
@@ -50,8 +50,11 @@ ObsGR(ObsBV = NULL, DatesR = NULL, Precip = NULL, PotEvap = NULL,
 }
 
 
-\description{Creation of the inputs required to the CalGR and SimGR functions}
+\description{Creation of the inputs required to run the CalGR and SimGR functions}
 
+\details{
+If the \code{ObsBV} argument is provided, \code{DatesR}, \code{Precip}, \code{PotEvap}, \code{Qobs} and \code{TempMean} are not necessary, and vice-versa. If one variable is provided in \code{ObsBV} and also separately, then only the data included in \code{ObsBV} are used. 
+}
 
 \author{Olivier Delaigue}