Commit c29bda9e authored by unknown's avatar unknown
Browse files

v0.1.11.15 revision of ShinyGR documentation

parent db863746
Package: airGRteaching
Type: Package
Title: Tools to Simplify the Use of the airGR Hydrological Package for Education (Including a Shiny Interface)
Version: 0.1.11.14
Version: 0.1.11.15
Date: 2018-01-31
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)
......
\encoding{UTF-8}
\name{ShinyGR}
\alias{ShinyGR}
\title{Interactive web application to run manually the GR4J, GR5 and GR6J hydrological models with or without CemaNeige}
\title{Interactive Web application to run manually the GR4J, GR5 and GR6J hydrological models with or without CemaNeige}
\usage{
......@@ -13,7 +13,7 @@ ShinyGR(ObsDF = NULL,
\arguments{
\item{ObsDF}{(optional) [data.frame or list of data.frame] \code{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{ObsDF}{(optional) [data.frame or list of data.frame] \code{data.frame} of dates, total precipitation, potential evapotranspiration, observed discharge 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"}
......@@ -21,17 +21,17 @@ ShinyGR(ObsDF = NULL,
\item{PotEvap}{(optional) [numeric] time series of potential evapotranspiration (catchment average) [mm], required to create the GR model inputs}
\item{Qobs}{(optional) [numeric] time series of observed discharges [mm/time step]}
\item{Qobs}{(optional) [numeric] time series of observed discharge [mm/time step]}
\item{TempMean}{(optional) [numeric] time series of mean air temperature [°C], required to create the CemaNeige model inputs}
\item{TempMean}{(optional) [numeric] time series of mean air temperature [°C], required to create the CemaNeige model inputs (if used)}
\item{ZInputs}{(optional) [numeric or list of numerics] 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 or list of numerics] real giving the mean elevation of the Precip and TempMean series (before extrapolation) [m], used to create the CemaNeige model inputs (if used)}
\item{HypsoData}{(optional) [numeric or list of numerics] 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 or list of numerics] 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 or list of numerics] integer giving the number of elevation layers requested [-], required to create CemaNeige model inputs}
\item{NLayers}{(optional) [numeric or list of numerics] integer giving the number of elevation layers requested [-], required to create CemaNeige model inputs (if used)}
\item{SimPer}{[character or list of characters] vector of 2 values to define the simulation period [\code{"YYYY-mm-dd"} or \code{"YYYY-mm-dd HH:MM:SS"}], see below for details}
\item{SimPer}{[character or list of characters] vector of 2 values to define the beginning and the end of the simulation period [\code{"YYYY-mm-dd"} or \code{"YYYY-mm-dd HH:MM:SS"}], see below for details}
\item{NamesObsBV}{(optional) [character] vector of values to define the data inputs name(s) (if the ObsDF list is not already named)}
......@@ -44,10 +44,10 @@ ShinyGR(ObsDF = NULL,
}
\description{Shiny application to understand the impact of each parameter of the GR models on the simulated flows}
\description{Shiny application to understand and to display in a interactive way the impact of each parameter of the GR models on the simulated flows}
\details{
If the \code{ObsDF} contains a list of several character names of datasets, the simulation period (defined in \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. The warm-up period always starts from the first date to the step time just before the start of the simulation period.
The warm-up period always starts from the first date of the dataset to the time step just before the beginning of the simulation period (\code{SimPer}).
}
\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