Commit be4afd07 authored by unknown's avatar unknown
Browse files

v0.1.2.42 ObsGR.Rd file updated #4598

parent 808ef607
Package: airGRteaching
Type: Package
Title: Tools to Simplify the Use of the airGR Hydrological Package for Education (Including a Shiny Application)
Version: 0.1.2.41
Version: 0.1.2.42
Date: 2017-04-10
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.5.22)
......
\encoding{UTF-8}
\name{ObsGR}
\alias{ObsGR}
\title{Creation of the inputs required to the CalGR and SimGR functions}
\title{Creation of the inputs required for the CalGR and SimGR functions}
\usage{
......@@ -13,25 +13,25 @@ ObsGR(ObsBV = NULL, DatesR = NULL, Precip = NULL, PotEvap = NULL,
\arguments{
\item{ObsBV}{[data.frame] data.frame of dates, total precipitation, potential evapotranspiration, observed discharges and mean air temperature (optional) (variables in this order; see below for the units)}
\item{ObsBV}{(optional) [data.frame] data.frame of dates, total precipitation, potential evapotranspiration, observed discharges and mean air temperature (optional) (variables must be in this order; see below for the units)}
\item{DatesR}{[POSIXt] vector of dates required to create the GR model and CemaNeige module inputs}
\item{DatesR}{(optional) [POSIXt] vector of dates required to create the GR and CemaNeige models inputs}
\item{Precip}{[numeric] time series of total precipitation (catchment average) [mm], required to create the GR model and CemaNeige module inputs}
\item{Precip}{(optional) [numeric] time series of total precipitation (catchment average) [mm], required to create the GR and CemaNeige models inputs}
\item{PotEvap}{[numeric] time series of potential evapotranspiration (catchment average) [mm], required to create the GR model inputs}
\item{PotEvap}{(optional) [numeric] time series of potential evapotranspiration (catchment average) [mm], required to create the GR model inputs}
\item{Qobs}{[numeric] series of observed discharges [mm/time step]}
\item{Qobs}{(optional) [numeric] time series of observed discharges [mm/time step]}
\item{TempMean}{(optional) [numeric] time series of mean air temperature [°C], required to create the CemaNeige module inputs}
\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 Temp series (before extrapolation) [m], possibly used to create the CemaNeige module 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{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{NLayers}{(optional) [numeric] integer giving the number of elevation layers requested [-], required to create CemaNeige module inputs}
\item{NLayers}{(optional) [numeric] integer giving the number of elevation layers requested [-], required to create CemaNeige model inputs}
\item{TypeModel}{[character] name of the hydrological model [\code{"GR1A"}, \code{"GR2M"}, \code{"GR4J"}, \code{"GR5J"}, \code{"GR6J"}, \code{"GR4H"}]}
\item{TypeModel}{[character] name of the hydrological model (must be one of \code{"GR1A"}, \code{"GR2M"}, \code{"GR4J"}, \code{"GR5J"}, \code{"GR6J"}, \code{"GR4H"})}
\item{CemaNeige}{[boolean] option indicating whether CemaNeige should be activated (only available when \code{TypeModel} is equal to any of \code{"GR4J"}, \code{"GR5J"} or \code{"GR6J"})}
}
......@@ -40,7 +40,7 @@ ObsGR(ObsBV = NULL, DatesR = NULL, Precip = NULL, PotEvap = NULL,
\value{
[list] object of class \code{ObsGR} containing the data required to evaluate the model outputs:
\item{InputsModel}{[list] object of class \emph{InputsModel} containing the data required to evaluate the model outputs (see: \code{\link{CreateInputsModel}} outputs)}
\item{Qobs}{[numeric] series of observed discharges [mm/time step]}
\item{Qobs}{[numeric] time series of observed discharges [mm/time step]}
\item{TypeModel}{[character] name of the function of the hydrological model used}
}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment