Commit 6212ae36 authored by unknown's avatar unknown
Browse files

v0.1.2.39 CalGR.Rd file updated #4598

parent 3225317c
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.39
Version: 0.1.2.40
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{CalGR}
\alias{CalGR}
\title{Calibration algorithm optimises the error criterion selected as objective function}
\title{Calibration algorithm that optimises the error criterion selected as objective function}
\usage{
......@@ -30,10 +30,10 @@ CalGR(ObsGR, CalCrit = c("NSE", "KGE", "KGE2", "RMSE"),
[list] object of class \code{CalGR} containing:
\item{OptionsCalib}{[list] object of class \code{RunOptions} (see: \code{\link{CreateRunOptions}})}
\item{Qobs}{[numeric] series of observed discharges [mm/time step]}
\item{OutputsCalib}{[list] object of class \code{OutputsCalib} see: (\code{\link{Calibration}})}
\item{OutputsModel}{[list] object of class \code{OutputsModel} see: (\code{\link{RunModel}})}
\item{OutputsCalib}{[list] object of class \code{OutputsCalib} (see: \code{\link{Calibration}}))}
\item{OutputsModel}{[list] object of class \code{OutputsModel} (see: \code{\link{RunModel}}))}
\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{CalCrit}{[character] name of the function that computes the error criterion during the calibration 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}
}
......@@ -43,7 +43,7 @@ CalGR(ObsGR, CalCrit = c("NSE", "KGE", "KGE2", "RMSE"),
}
\description{Calibration algorithm optimises the error criterion selected as objective function using the Irstea-HBAN procedure described by C. Michel}
\description{Calibration algorithm that optimises the error criterion selected as objective function using the Irstea-HBAN procedure described by C. Michel}
\author{Olivier Delaigue}
......
......@@ -20,10 +20,12 @@ The package is mostly based on three families of functions: \cr
# --- Modelling Functions
Three functions allow to complete very simply a hydrological modelling exercise:
Three functions allow to complete very simply a hydrological modelling exercise: \cr
- preparation of data: \code{\link{ObsGR}()}; \cr
- calibration of the models: \code{\link{CalGR}()}; \cr
- simulation with the models: \code{\link{SimGR}()}); \cr
\cr\cr
# --- Plotting Functions
......
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