PrepGR.Rd 3.28 KB
 unknown committed Dec 16, 2016 1 \encoding{UTF-8}  unknown committed Jan 30, 2018 2 3 \name{PrepGR} \alias{PrepGR}  unknown committed Jan 30, 2018 4 \title{Creation of the inputs required to run the CalGR and SimGR functions}  unknown committed Dec 16, 2016 5 6 7  \usage{  unknown committed Jan 30, 2018 8 9 10 11 PrepGR(ObsBV = NULL, DatesR = NULL, Precip = NULL, PotEvap = NULL, Qobs = NULL, TempMean = NULL, ZInputs = NULL, HypsoData = NULL, NLayers = 5, HydroModel, CemaNeige = FALSE)  unknown committed Dec 16, 2016 12 13 14 15 } \arguments{  unknown committed Jun 01, 2017 16  \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)}  unknown committed Dec 16, 2016 17   unknown committed Jan 30, 2018 18  \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"}  unknown committed Dec 16, 2016 19   unknown committed Jan 30, 2018 20  \item{Precip}{(optional) [numeric] time series of total precipitation (catchment average) [mm], required to create the GR and CemaNeige (if used) models inputs}  unknown committed Dec 16, 2016 21   unknown committed Jun 01, 2017 22  \item{PotEvap}{(optional) [numeric] time series of potential evapotranspiration (catchment average) [mm], required to create the GR model inputs}  unknown committed Dec 16, 2016 23   unknown committed Jun 01, 2017 24  \item{Qobs}{(optional) [numeric] time series of observed discharges [mm/time step]}  unknown committed Dec 16, 2016 25   unknown committed Jun 01, 2017 26  \item{TempMean}{(optional) [numeric] time series of mean air temperature [°C], required to create the CemaNeige model inputs}  unknown committed Dec 16, 2016 27   unknown committed Jan 30, 2018 28  \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}  unknown committed Dec 16, 2016 29   unknown committed Jan 30, 2018 30  \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)}  unknown committed Dec 16, 2016 31   unknown committed Jan 30, 2018 32  \item{NLayers}{(optional) [numeric] integer giving the number of elevation layers requested [-], required to create CemaNeige (if used) model inputs}  unknown committed Dec 16, 2016 33   unknown committed Sep 06, 2017 34  \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"})}  unknown committed Dec 16, 2016 35   unknown committed Sep 06, 2017 36  \item{CemaNeige}{[boolean] option indicating whether CemaNeige should be activated (only available when \code{HydroModel} is equal to any of \code{"GR4J"}, \code{"GR5J"} or \code{"GR6J"})}  unknown committed Dec 16, 2016 37 38 39 }  unknown committed Jan 25, 2017 40 \value{  unknown committed Jan 30, 2018 41  [list] object of class \code{PrepGR} containing the data required to evaluate the model outputs:  unknown committed Jan 25, 2017 42  \item{InputsModel}{[list] object of class \emph{InputsModel} containing the data required to evaluate the model outputs (see: \code{\link{CreateInputsModel}} outputs)}  unknown committed Jun 01, 2017 43  \item{Qobs}{[numeric] time series of observed discharges [mm/time step]}  unknown committed Sep 06, 2017 44  \item{HydroModel}{[character] name of the function of the hydrological model used}  unknown committed Jan 25, 2017 45 46 47 }  unknown committed Dec 16, 2016 48 49 50 51 52 \seealso{ \code{\link{CreateInputsModel}} }  unknown committed Jan 30, 2018 53 \description{Creation of the inputs required to run the CalGR and SimGR functions}  unknown committed Dec 16, 2016 54   unknown committed Jan 30, 2018 55 56 57 \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. }  unknown committed Dec 16, 2016 58 59 60  \author{Olivier Delaigue}  unknown committed Jan 25, 2017 61   unknown committed Dec 16, 2016 62 63 64 65 66 67 68 69 \examples{ library(airGR) ## data.frame of observed data data(L0123001) BasinObs2 <- BasinObs[, c("DatesR", "P", "E", "Qmm", "T")] ## Preparation of observed data for modelling  unknown committed Jan 30, 2018 70 71 PREP <- PrepGR(ObsBV = BasinObs2, HydroModel = "GR4J", CemaNeige = FALSE) str(PREP)  unknown committed Dec 16, 2016 72 73 }