Commit acb6a3b3 authored by unknown's avatar unknown
Browse files

v0.1.2.46 ShinyGR.Rd file updated #4598

parent e4c30ecc
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.45
Version: 0.1.2.46
Date: 2017-06-01
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)
......
......@@ -13,7 +13,7 @@ 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 (optional) (variables must be 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 (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}
......@@ -27,7 +27,7 @@ ObsGR(ObsBV = NULL, DatesR = NULL, Precip = NULL, PotEvap = NULL,
\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{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 model inputs}
......
\encoding{UTF-8}
\name{ShinyGR}
\alias{ShinyGR}
\title{Interactive web application to run manually the GR4,5,6J hydrological models whith or without CemaNeige}
\title{Interactive web application to run manually the GR4J, GR5 and GR6J hydrological models with or without CemaNeige}
\usage{
......@@ -14,31 +14,31 @@ ShinyGR(ObsBV = NULL, DatesR = NULL, Precip = NULL, PotEvap = NULL,
\arguments{
\item{ObsBV}{[list] character names of the data.frame of dates, total precipitation, evapotranspiration, observed discharges and mean air temperature (optional) (variables in this order)}
\item{ObsBV}{(optional) [list] character names of the data.frame of dates, total precipitation, 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}{[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{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{Param}{[numeric] vector of parameters (the number depends on the model used ; default = \code{c(200, 0, 100, 2)})}
\item{Param}{[numeric] vector of parameters (the number depends on the model used; default = \code{c(200, 0, 100, 2)})}
\item{WupPer}{(optional) [character] vector of 2 values to define the warm-up period [\code{"YYYY-mm-dd"} or \code{"YYYY-mm-dd HH:MM:SS"}]}
\item{SimPer}{[character] vector of 2 values to define the simulation period [\code{"YYYY-mm-dd"} or \code{"YYYY-mm-dd HH:MM:SS"}]}
\item{theme}{[character] alternative stylesheet [\code{"RStudio"} (default), \code{"Cerulean"}, \code{"Cyborg"}, \code{"Flatly"}, \code{"United"} or \code{"Yeti"}]}
\item{theme}{(optional) [character] alternative stylesheet [\code{"RStudio"} (default), \code{"Cerulean"}, \code{"Cyborg"}, \code{"Flatly"}, \code{"United"} or \code{"Yeti"}]}
}
......@@ -47,10 +47,10 @@ ShinyGR(ObsBV = NULL, DatesR = NULL, Precip = NULL, PotEvap = NULL,
}
\description{Shiny application to understand the role of each parameter of the GR4J model}
\description{Shiny application to understand the impact of each parameter of the GR models on the simulated flows}
\details{
If the \code{ObsBV} contains a list of many character names of datasets, the different periods (defined in \code{WupPer} and/or \code{SimPer} will be apply on all datasets. So the user have to check that the periods are common to the different datasets.
If the \code{ObsBV} contains a list of several character names of datasets, the different periods (defined in \code{WupPer} and/or \code{SimPer}) will be applied on all datasets. As a consequence it is necessary to check that the periods are common to the different datasets.
}
\author{
......
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