Commit 982accf0 authored by unknown's avatar unknown
Browse files

v0.1.2.47 SimGR.Rd file updated #4598

parent acb6a3b3
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.46
Version: 0.1.2.47
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)
......
......@@ -14,7 +14,7 @@ CalGR(ObsGR, CalCrit = c("NSE", "KGE", "KGE2", "RMSE"),
\arguments{
\item{ObsGR}{[object of class \code{ObsGR}] see \code{\link{ObsGR}} for details}
\item{CalCrit}{[character] name of the objective function (must be on of \code{"NSE"}, \code{"KGE"}, \code{"KGE2"}, \code{"RMSE"})}
\item{CalCrit}{[character] name of the objective function (must be one of \code{"NSE"}, \code{"KGE"}, \code{"KGE2"}, \code{"RMSE"})}
\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"}]}
......
\encoding{UTF-8}
\name{SimGR}
\alias{SimGR}
\title{Run GR hydrological models}
\title{Perform a run for the GR hydrological models}
\usage{
......@@ -12,13 +12,13 @@ SimGR(ObsGR, CalGR = NULL, Param = NULL, EffCrit = c("NSE", "KGE", "KGE2", "RMSE
\arguments{
\item{ObsGR}{[object of class \emph{ObsGR}] see \code{\link{ObsGR}} for details}
\item{ObsGR}{[object of class \emph{ObsGR}] (see \code{\link{ObsGR}} for details)}
\item{CalGR}{[object of class \emph{CalGR}] see \code{\link{CalGR}} for details}
\item{CalGR}{(optional) [object of class \emph{CalGR}] (see \code{\link{CalGR}} for details)}
\item{Param}{[numeric] vector of parameters (the number depends on the model used)}
\item{Param}{(optional) [numeric] vector of parameters (the number depends on the model used)}
\item{EffCrit}{[character] name of the efficiency criterion (must be on of \code{"NSE"}, \code{"KGE"}, \code{"KGE2"}, \code{"RMSE"})}
\item{EffCrit}{[character] name of the efficiency criterion (must be one of \code{"NSE"}, \code{"KGE"}, \code{"KGE2"}, \code{"RMSE"})}
\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"}]}
......@@ -37,8 +37,8 @@ SimGR(ObsGR, CalGR = NULL, Param = NULL, EffCrit = c("NSE", "KGE", "KGE2", "RMSE
\item{OutputsModel}{[list] object of class \code{OutputsModel} (see: \code{\link{RunModel}})}
\item{Qobs}{[numeric] series of observed discharges [mm/time step]}
\item{TypeModel}{[character] name of the function of the hydrological model used}
\item{CalCrit}{[character] name of the function which computes the error criterion during the calibration step}
\item{EffCrit}{[list] name of the function which computes the error criterion during the simulation step}
\item{CalCrit}{[character] name of the function that computes the error criterion during the calibration step}
\item{EffCrit}{[list] name of the function that computes the error criterion during the simulation step}
\item{PeriodModel}{[list] \code{$WarmUp}: vector of 2 \code{POSIXct} values defining the warm-up period, \code{$Run}: vector of 2 \code{POSIXct} values defining the calibration period}
}
......@@ -49,7 +49,7 @@ SimGR(ObsGR, CalGR = NULL, Param = NULL, EffCrit = c("NSE", "KGE", "KGE2", "RMSE
}
\description{Run GR hydrological models}
\description{Function for running the GR hydrological models}
\author{Olivier Delaigue}
......
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