Commit 3ac14d8c authored by unknown's avatar unknown
Browse files

v1.0.9.25 many typo revision in documentation

parent 1ff89e29
Package: airGR Package: airGR
Type: Package Type: Package
Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
Version: 1.0.9.24 Version: 1.0.9.25
Date: 2017-08-18 Date: 2017-08-18
Authors@R: c( Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl")), person("Laurent", "Coron", role = c("aut", "trl")),
......
This diff is collapsed.
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
### 1.0.9.24 Release Notes (2017-08-18) ### 1.0.9.25 Release Notes (2017-08-18)
#### New features #### New features
...@@ -128,13 +128,13 @@ ________________________________________________________________________________ ...@@ -128,13 +128,13 @@ ________________________________________________________________________________
#### New features #### New features
- <code>SeriesAggreg()</code> gains a TimeLag argument that corresponds to a numeric value indicating a time lag (in seconds) for the time series aggregation (useful to aggregate hourly time series to the daily time step for instance). - <code>SeriesAggreg()</code> gains a TimeLag argument that corresponds to a numeric value indicating a time lag (in seconds) for the time series aggregation (useful to aggregate hourly time series to the daily time step for instance).
In addition, the function now accepts input dates in both POSIXt formats (POSIXct and POSIXlt). The output is in POSIXct format. In addition, the function now accepts input dates in both POSIXt formats (POSIXct and POSIXlt). The output is in POSIXct format.
- <code>plot_OutputsModel()</code> gains a <code>log_scale</code> argument in order to plot the flow with a log scale. - <code>plot_OutputsModel()</code> gains a <code>log_scale</code> argument in order to plot the flow with a log scale.
- A tutorial is available online on the following link: from http://webgr.irstea.fr/airGR. - A tutorial is available online on the following link: from http://webgr.irstea.fr/airGR.
It can also be displayed with the <code>vignette("airGR")</code> command It can also be displayed with the <code>vignette("airGR")</code> command
#### Bug fixes #### Bug fixes
...@@ -147,13 +147,13 @@ ________________________________________________________________________________ ...@@ -147,13 +147,13 @@ ________________________________________________________________________________
- <code>CreateCalibOptions()</code> loses the StartParam argument that was not used. - <code>CreateCalibOptions()</code> loses the StartParam argument that was not used.
#### Major user-visible changes #### Major user-visible changes
- The <code>RunModel_GR6J()</code> and <code>RunModel_CemaNeigeGR6J()</code> models were modified back to versions previous to 1.0.1 to prevent from unwanted efficiency criteria deterioration related to the calibration with <code>Calibration_Michel()</code>. - The <code>RunModel_GR6J()</code> and <code>RunModel_CemaNeigeGR6J()</code> models were modified back to versions previous to 1.0.1 to prevent from unwanted efficiency criteria deterioration related to the calibration with <code>Calibration_Michel()</code>.
The actual model codes were not modified but the <code>TransfoParam_GR6J()</code> and <code>CreateCalibOptions()</code> functions were modified regarding the X5 parameter. The actual model codes were not modified but the <code>TransfoParam_GR6J()</code> and <code>CreateCalibOptions()</code> functions were modified regarding the X5 parameter.
It is strongly advised to use airGR 1.0.2 for the <code>RunModel_GR6J()</code> and <code>RunModel_CemaNeigeGR6J()</code> functions if you are using <code>Calibration_Michel()</code>, as they are much more efficient. It is strongly advised to use airGR 1.0.2 for the <code>RunModel_GR6J()</code> and <code>RunModel_CemaNeigeGR6J()</code> functions if you are using <code>Calibration_Michel()</code>, as they are much more efficient.
In case you were using your own calibration algorithm, you will not notice any difference. In case you were using your own calibration algorithm, you will not notice any difference.
#### Minor user-visible changes #### Minor user-visible changes
...@@ -172,13 +172,13 @@ ________________________________________________________________________________ ...@@ -172,13 +172,13 @@ ________________________________________________________________________________
- The <code>Calibration_optim()</code> function has been removed from the package. - The <code>Calibration_optim()</code> function has been removed from the package.
- The silent mode is now defined by the <code>verbose = TRUE</code> argument (formerly <code>quiet = FALSE</code>) in the following functions : - The silent mode is now defined by the <code>verbose = TRUE</code> argument (formerly <code>quiet = FALSE</code>) in the following functions:
<code>Calibration()</code>, <code>Calibration_Michel()</code>, <code>CreateInputsModel()</code>, <code>CreateRunOptions()</code>, <code>DataAltiExtrapolation_Valery()</code>, <code>ErrorCrit()</code>, <code>ErrorCrit_KGE()</code>, <code>ErrorCrit_KGE2()</code>, <code>ErrorCrit_NSE()</code>, <code>ErrorCrit_RMSE()</code>, <code>plot_OutputsModel()</code>, <code>SeriesAggreg()</code>. <code>Calibration()</code>, <code>Calibration_Michel()</code>, <code>CreateInputsModel()</code>, <code>CreateRunOptions()</code>, <code>DataAltiExtrapolation_Valery()</code>, <code>ErrorCrit()</code>, <code>ErrorCrit_KGE()</code>, <code>ErrorCrit_KGE2()</code>, <code>ErrorCrit_NSE()</code>, <code>ErrorCrit_RMSE()</code>, <code>plot_OutputsModel()</code>, <code>SeriesAggreg()</code>.
#### Major user-visible changes #### Major user-visible changes
- The GR5J model has been modified: previously, two unit hydrographs were used, now only one is remaining. - The GR5J model has been modified: previously, two unit hydrographs were used, now only one is remaining.
As a consequence, simulations from the GR5J (<code>RunModel_GR5J()</code> function) and CemaNeige (<code>RunModel_CemaNeigeGR5J()</code> function) models will be different. As a consequence, simulations from the GR5J (<code>RunModel_GR5J()</code> function) and CemaNeige (<code>RunModel_CemaNeigeGR5J()</code> function) models will be different.
- An important proportion of the transformations of the parameters have been modified (<code>TransfoParam&#42;()</code> functions). Since this modifies the local search, calibration results will be different . - An important proportion of the transformations of the parameters have been modified (<code>TransfoParam&#42;()</code> functions). Since this modifies the local search, calibration results will be different .
...@@ -225,7 +225,7 @@ ________________________________________________________________________________ ...@@ -225,7 +225,7 @@ ________________________________________________________________________________
#### New features #### New features
- Three new hydrological models: <code>RunModel_GR4H() function for </code> GR4H (hourly), <code>RunModel_GR2M()</code> function for GR2M (monthly) and <code>RunModel_GR1A()</code> function for GR1A (yearly). - Three new hydrological models: <code>RunModel_GR4H() function for </code> GR4H (hourly), <code>RunModel_GR2M()</code> function for GR2M (monthly) and <code>RunModel_GR1A()</code> function for GR1A (yearly).
- New function <code>SeriesAggreg()</code> to easily aggreg timesteps. - New function <code>SeriesAggreg()</code> to easily aggreg timesteps.
...@@ -295,7 +295,7 @@ ________________________________________________________________________________ ...@@ -295,7 +295,7 @@ ________________________________________________________________________________
- CemaNeige users must now specify one <code>MeanAnSolidPrecip</code> for each elevation layer. The <code>CreateRunOptions()</code> function is impacted. - CemaNeige users must now specify one <code>MeanAnSolidPrecip</code> for each elevation layer. The <code>CreateRunOptions()</code> function is impacted.
- CemaNeige users can now specify the mean elevation of the input series (before it was always considered equal to the catchment median elevation). - CemaNeige users can now specify the mean elevation of the input series (before it was always considered equal to the catchment median elevation).
The impacted functions are <code>CreateInputsModel()</code> and <code>DataAltiExtrapolation_HBAN()</code>. The impacted functions are <code>CreateInputsModel()</code> and <code>DataAltiExtrapolation_HBAN()</code>.
#### Minor user-visible changes #### Minor user-visible changes
...@@ -324,7 +324,7 @@ ________________________________________________________________________________ ...@@ -324,7 +324,7 @@ ________________________________________________________________________________
- New architecture with better format verification procedure (using classes) and simpler setting of default configuration. - New architecture with better format verification procedure (using classes) and simpler setting of default configuration.
- New architecture where the model, calibration and error functions are in the arguments of the functions - New architecture where the model, calibration and error functions are in the arguments of the functions
(the exotic use of "generic function" created by the users has been removed). (the exotic use of "generic function" created by the users has been removed).
- Improved documentation and examples. - Improved documentation and examples.
...@@ -359,12 +359,12 @@ ________________________________________________________________________________ ...@@ -359,12 +359,12 @@ ________________________________________________________________________________
- RC6 correction of the help files (the description of CemaNeige parameters were inverted). - RC6 correction of the help files (the description of CemaNeige parameters were inverted).
- RC5 differs from previous releases in the way the data are read and stored (in a list instead of individual vectors). - RC5 differs from previous releases in the way the data are read and stored (in a list instead of individual vectors).
The package is similar, only the examples of Main and the files in MyScriptBlocks have changed. The package is similar, only the examples of Main and the files in MyScriptBlocks have changed.
All basin data are now stored inside a list named <code>BasinData</code>. This will greatly ease the future use of Rdata files (instead of txt files) as storage format for the time series of observation. All basin data are now stored inside a list named <code>BasinData</code>. This will greatly ease the future use of Rdata files (instead of txt files) as storage format for the time series of observation.
____________________________________________________________________________________ ____________________________________________________________________________________
### 0.6.1 Release Notes (2014-02-12) ### 0.6.1 Release Notes (2014-02-12)
...@@ -389,13 +389,13 @@ ________________________________________________________________________________ ...@@ -389,13 +389,13 @@ ________________________________________________________________________________
____________________________________________________________________________________ ____________________________________________________________________________________
### 0.6.0 Release Notes (2014-02-12) ### 0.6.0 Release Notes (2014-02-12)
#### New features #### New features
- The field Multiplier has been added in the ErrorCrit() outputs, to indicate whether the criterion is an error (to minimise) or and efficiency (to maximise). - The field Multiplier has been added in the ErrorCrit() outputs, to indicate whether the criterion is an error (to minimise) or and efficiency (to maximise).
This allows to provide real efficiency values in the outputs e.g. NSE[Q] instead of (-1) &times; NSE[Q]. This allows to provide real efficiency values in the outputs e.g. NSE[Q] instead of (-1) &times; NSE[Q].
#### Deprectated and defunct #### Deprectated and defunct
...@@ -436,7 +436,7 @@ ________________________________________________________________________________ ...@@ -436,7 +436,7 @@ ________________________________________________________________________________
____________________________________________________________________________________ ____________________________________________________________________________________
### 0.5.1 Release Notes (2014-01-27) ### 0.5.1 Release Notes (2014-01-27)
#### New features #### New features
......
...@@ -8,7 +8,7 @@ output: ...@@ -8,7 +8,7 @@ output:
### 1.0.9.24 Release Notes (2017-08-18) ### 1.0.9.25 Release Notes (2017-08-18)
#### New features #### New features
...@@ -133,13 +133,13 @@ ________________________________________________________________________________ ...@@ -133,13 +133,13 @@ ________________________________________________________________________________
#### New features #### New features
- <code>SeriesAggreg()</code> gains a TimeLag argument that corresponds to a numeric value indicating a time lag (in seconds) for the time series aggregation (useful to aggregate hourly time series to the daily time step for instance). - <code>SeriesAggreg()</code> gains a TimeLag argument that corresponds to a numeric value indicating a time lag (in seconds) for the time series aggregation (useful to aggregate hourly time series to the daily time step for instance).
In addition, the function now accepts input dates in both POSIXt formats (POSIXct and POSIXlt). The output is in POSIXct format. In addition, the function now accepts input dates in both POSIXt formats (POSIXct and POSIXlt). The output is in POSIXct format.
- <code>plot_OutputsModel()</code> gains a <code>log_scale</code> argument in order to plot the flow with a log scale. - <code>plot_OutputsModel()</code> gains a <code>log_scale</code> argument in order to plot the flow with a log scale.
- A tutorial is available online on the following link: from http://webgr.irstea.fr/airGR. - A tutorial is available online on the following link: from http://webgr.irstea.fr/airGR.
It can also be displayed with the <code>vignette("airGR")</code> command It can also be displayed with the <code>vignette("airGR")</code> command
#### Bug fixes #### Bug fixes
...@@ -152,13 +152,13 @@ ________________________________________________________________________________ ...@@ -152,13 +152,13 @@ ________________________________________________________________________________
- <code>CreateCalibOptions()</code> loses the StartParam argument that was not used. - <code>CreateCalibOptions()</code> loses the StartParam argument that was not used.
#### Major user-visible changes #### Major user-visible changes
- The <code>RunModel_GR6J()</code> and <code>RunModel_CemaNeigeGR6J()</code> models were modified back to versions previous to 1.0.1 to prevent from unwanted efficiency criteria deterioration related to the calibration with <code>Calibration_Michel()</code>. - The <code>RunModel_GR6J()</code> and <code>RunModel_CemaNeigeGR6J()</code> models were modified back to versions previous to 1.0.1 to prevent from unwanted efficiency criteria deterioration related to the calibration with <code>Calibration_Michel()</code>.
The actual model codes were not modified but the <code>TransfoParam_GR6J()</code> and <code>CreateCalibOptions()</code> functions were modified regarding the X5 parameter. The actual model codes were not modified but the <code>TransfoParam_GR6J()</code> and <code>CreateCalibOptions()</code> functions were modified regarding the X5 parameter.
It is strongly advised to use airGR 1.0.2 for the <code>RunModel_GR6J()</code> and <code>RunModel_CemaNeigeGR6J()</code> functions if you are using <code>Calibration_Michel()</code>, as they are much more efficient. It is strongly advised to use airGR 1.0.2 for the <code>RunModel_GR6J()</code> and <code>RunModel_CemaNeigeGR6J()</code> functions if you are using <code>Calibration_Michel()</code>, as they are much more efficient.
In case you were using your own calibration algorithm, you will not notice any difference. In case you were using your own calibration algorithm, you will not notice any difference.
#### Minor user-visible changes #### Minor user-visible changes
...@@ -177,13 +177,13 @@ ________________________________________________________________________________ ...@@ -177,13 +177,13 @@ ________________________________________________________________________________
- The <code>Calibration_optim()</code> function has been removed from the package. - The <code>Calibration_optim()</code> function has been removed from the package.
- The silent mode is now defined by the <code>verbose = TRUE</code> argument (formerly <code>quiet = FALSE</code>) in the following functions : - The silent mode is now defined by the <code>verbose = TRUE</code> argument (formerly <code>quiet = FALSE</code>) in the following functions:
<code>Calibration()</code>, <code>Calibration_Michel()</code>, <code>CreateInputsModel()</code>, <code>CreateRunOptions()</code>, <code>DataAltiExtrapolation_Valery()</code>, <code>ErrorCrit()</code>, <code>ErrorCrit_KGE()</code>, <code>ErrorCrit_KGE2()</code>, <code>ErrorCrit_NSE()</code>, <code>ErrorCrit_RMSE()</code>, <code>plot_OutputsModel()</code>, <code>SeriesAggreg()</code>. <code>Calibration()</code>, <code>Calibration_Michel()</code>, <code>CreateInputsModel()</code>, <code>CreateRunOptions()</code>, <code>DataAltiExtrapolation_Valery()</code>, <code>ErrorCrit()</code>, <code>ErrorCrit_KGE()</code>, <code>ErrorCrit_KGE2()</code>, <code>ErrorCrit_NSE()</code>, <code>ErrorCrit_RMSE()</code>, <code>plot_OutputsModel()</code>, <code>SeriesAggreg()</code>.
#### Major user-visible changes #### Major user-visible changes
- The GR5J model has been modified: previously, two unit hydrographs were used, now only one is remaining. - The GR5J model has been modified: previously, two unit hydrographs were used, now only one is remaining.
As a consequence, simulations from the GR5J (<code>RunModel_GR5J()</code> function) and CemaNeige (<code>RunModel_CemaNeigeGR5J()</code> function) models will be different. As a consequence, simulations from the GR5J (<code>RunModel_GR5J()</code> function) and CemaNeige (<code>RunModel_CemaNeigeGR5J()</code> function) models will be different.
- An important proportion of the transformations of the parameters have been modified (<code>TransfoParam&#42;()</code> functions). Since this modifies the local search, calibration results will be different . - An important proportion of the transformations of the parameters have been modified (<code>TransfoParam&#42;()</code> functions). Since this modifies the local search, calibration results will be different .
...@@ -230,7 +230,7 @@ ________________________________________________________________________________ ...@@ -230,7 +230,7 @@ ________________________________________________________________________________
#### New features #### New features
- Three new hydrological models: <code>RunModel_GR4H() function for </code> GR4H (hourly), <code>RunModel_GR2M()</code> function for GR2M (monthly) and <code>RunModel_GR1A()</code> function for GR1A (yearly). - Three new hydrological models: <code>RunModel_GR4H() function for </code> GR4H (hourly), <code>RunModel_GR2M()</code> function for GR2M (monthly) and <code>RunModel_GR1A()</code> function for GR1A (yearly).
- New function <code>SeriesAggreg()</code> to easily aggreg timesteps. - New function <code>SeriesAggreg()</code> to easily aggreg timesteps.
...@@ -300,7 +300,7 @@ ________________________________________________________________________________ ...@@ -300,7 +300,7 @@ ________________________________________________________________________________
- CemaNeige users must now specify one <code>MeanAnSolidPrecip</code> for each elevation layer. The <code>CreateRunOptions()</code> function is impacted. - CemaNeige users must now specify one <code>MeanAnSolidPrecip</code> for each elevation layer. The <code>CreateRunOptions()</code> function is impacted.
- CemaNeige users can now specify the mean elevation of the input series (before it was always considered equal to the catchment median elevation). - CemaNeige users can now specify the mean elevation of the input series (before it was always considered equal to the catchment median elevation).
The impacted functions are <code>CreateInputsModel()</code> and <code>DataAltiExtrapolation_HBAN()</code>. The impacted functions are <code>CreateInputsModel()</code> and <code>DataAltiExtrapolation_HBAN()</code>.
#### Minor user-visible changes #### Minor user-visible changes
...@@ -329,7 +329,7 @@ ________________________________________________________________________________ ...@@ -329,7 +329,7 @@ ________________________________________________________________________________
- New architecture with better format verification procedure (using classes) and simpler setting of default configuration. - New architecture with better format verification procedure (using classes) and simpler setting of default configuration.
- New architecture where the model, calibration and error functions are in the arguments of the functions - New architecture where the model, calibration and error functions are in the arguments of the functions
(the exotic use of "generic function" created by the users has been removed). (the exotic use of "generic function" created by the users has been removed).
- Improved documentation and examples. - Improved documentation and examples.
...@@ -364,12 +364,12 @@ ________________________________________________________________________________ ...@@ -364,12 +364,12 @@ ________________________________________________________________________________
- RC6 correction of the help files (the description of CemaNeige parameters were inverted). - RC6 correction of the help files (the description of CemaNeige parameters were inverted).
- RC5 differs from previous releases in the way the data are read and stored (in a list instead of individual vectors). - RC5 differs from previous releases in the way the data are read and stored (in a list instead of individual vectors).
The package is similar, only the examples of Main and the files in MyScriptBlocks have changed. The package is similar, only the examples of Main and the files in MyScriptBlocks have changed.
All basin data are now stored inside a list named <code>BasinData</code>. This will greatly ease the future use of Rdata files (instead of txt files) as storage format for the time series of observation. All basin data are now stored inside a list named <code>BasinData</code>. This will greatly ease the future use of Rdata files (instead of txt files) as storage format for the time series of observation.
____________________________________________________________________________________ ____________________________________________________________________________________
### 0.6.1 Release Notes (2014-02-12) ### 0.6.1 Release Notes (2014-02-12)
...@@ -394,13 +394,13 @@ ________________________________________________________________________________ ...@@ -394,13 +394,13 @@ ________________________________________________________________________________
____________________________________________________________________________________ ____________________________________________________________________________________
### 0.6.0 Release Notes (2014-02-12) ### 0.6.0 Release Notes (2014-02-12)
#### New features #### New features
- The field Multiplier has been added in the ErrorCrit() outputs, to indicate whether the criterion is an error (to minimise) or and efficiency (to maximise). - The field Multiplier has been added in the ErrorCrit() outputs, to indicate whether the criterion is an error (to minimise) or and efficiency (to maximise).
This allows to provide real efficiency values in the outputs e.g. NSE[Q] instead of (-1) &times; NSE[Q]. This allows to provide real efficiency values in the outputs e.g. NSE[Q] instead of (-1) &times; NSE[Q].
#### Deprectated and defunct #### Deprectated and defunct
...@@ -441,7 +441,7 @@ ________________________________________________________________________________ ...@@ -441,7 +441,7 @@ ________________________________________________________________________________
____________________________________________________________________________________ ____________________________________________________________________________________
### 0.5.1 Release Notes (2014-01-27) ### 0.5.1 Release Notes (2014-01-27)
#### New features #### New features
......
\docType{data} \docType{data}
\encoding{UTF-8} \encoding{UTF-8}
\name{BasinInfo} \name{BasinInfo}
\alias{BasinInfo} \alias{BasinInfo}
\title{Data sample: characteristics of a fictional catchment (L0123001, L0123002 or L0123003)} \title{Data sample: characteristics of a fictional catchment (L0123001, L0123002 or L0123003)}
\format{List named 'BasinInfo' containing \format{List named 'BasinInfo' containing
\itemize{ \itemize{
\item two strings: catchment's code and station's name \item two strings: catchment's code and station's name
...@@ -13,10 +16,17 @@ ...@@ -13,10 +16,17 @@
\item one numeric vector: catchment's hypsometric curve (min, quantiles 01 to 99 and max) in metres \item one numeric vector: catchment's hypsometric curve (min, quantiles 01 to 99 and max) in metres
}} }}
\description{ \description{
R-object containing the code, station's name, area and hypsometric curve of the catchment. R-object containing the code, station's name, area and hypsometric curve of the catchment.
} }
\seealso{
\code{\link{BasinObs}}.
}
\examples{ \examples{
library(airGR) library(airGR)
data(L0123001) data(L0123001)
......
\docType{data} \docType{data}
\encoding{UTF-8} \encoding{UTF-8}
\name{BasinObs}
\name{BasinObs}
\alias{BasinObs} \alias{BasinObs}
\alias{L0123001} \alias{L0123001}
\alias{L0123002} \alias{L0123002}
\alias{L0123003} \alias{L0123003}
\title{Data sample: time series of observations of a fictional catchment (L0123001, L0123002 or L0123003)} \title{Data sample: time series of observations of a fictional catchment (L0123001, L0123002 or L0123003)}
\format{Data frame named 'BasinObs' containing \format{Data frame named 'BasinObs' containing
\itemize{ \itemize{
\item one POSIXct vector: time series dates in the POSIXct format \item one POSIXct vector: time series dates in the POSIXct format
\item five numeric vectors: time series of catchment average precipitation [mm/time step], catchment average air temperature [°C], catchment average potential evapotranspiration [mm/time step], outlet discharge [l/s], outlet discharge [mm/time step] \item five numeric vectors: time series of catchment average precipitation [mm/time step], catchment average air temperature [°C], catchment average potential evapotranspiration [mm/time step], outlet discharge [l/s], outlet discharge [mm/time step]
}} }}
\description{ \description{
R-object containing the times series of precipitation, temperature, potential evapotranspiration and discharges. \cr R-object containing the times series of precipitation, temperature, potential evapotranspiration and discharges. \cr
Times series for L0123001 or L0123002 are at the daily time step for use with daily models such as GR4J, GR5J, GR6J, CemaNeigeGR4J, CemaNeigeGR5J and CemaNeigeGR6J. Times series for L0123001 or L0123002 are at the daily time step for use with daily models such as GR4J, GR5J, GR6J, CemaNeigeGR4J, CemaNeigeGR5J and CemaNeigeGR6J.
Times series for L0123003 are at the hourly time step for use with hourly models such as GR4H. Times series for L0123003 are at the hourly time step for use with hourly models such as GR4H.
} }
\seealso{ \seealso{
\code{\link{BasinInfo}}. \code{\link{BasinInfo}}.
} }
......
\encoding{UTF-8} \encoding{UTF-8}
\name{Calibration} \name{Calibration}
\alias{Calibration} \alias{Calibration}
\title{Calibration algorithm which optimises the error criterion selected as objective function using the provided functions} \title{Calibration algorithm which optimises the error criterion selected as objective function using the provided functions}
\usage{ \usage{
Calibration(InputsModel, RunOptions, InputsCrit, CalibOptions, FUN_MOD, Calibration(InputsModel, RunOptions, InputsCrit, CalibOptions, FUN_MOD,
FUN_CRIT, FUN_CALIB = Calibration_Michel, FUN_TRANSFO = NULL, FUN_CRIT, FUN_CALIB = Calibration_Michel, FUN_TRANSFO = NULL,
verbose = TRUE) verbose = TRUE)
} }
\arguments{ \arguments{
\item{InputsModel}{[object of class \emph{InputsModel}] see \code{\link{CreateInputsModel}} for details} \item{InputsModel}{[object of class \emph{InputsModel}] see \code{\link{CreateInputsModel}} for details}
...@@ -16,22 +23,28 @@ Calibration(InputsModel, RunOptions, InputsCrit, CalibOptions, FUN_MOD, ...@@ -16,22 +23,28 @@ Calibration(InputsModel, RunOptions, InputsCrit, CalibOptions, FUN_MOD,
\item{CalibOptions}{[object of class \emph{CalibOptions}] see \code{\link{CreateCalibOptions}} for details} \item{CalibOptions}{[object of class \emph{CalibOptions}] see \code{\link{CreateCalibOptions}} for details}
\item{FUN_MOD}{[function] hydrological model function (e.g. RunModel_GR4J, RunModel_CemaNeigeGR4J)} \item{FUN_MOD}{[function] hydrological model function (e.g. \code{\link{RunModel_GR4J}}, \code{\link{RunModel_CemaNeigeGR4J}})}
\item{FUN_CRIT}{[function] error criterion function (e.g. ErrorCrit_RMSE, ErrorCrit_NSE)} \item{FUN_CRIT}{[function] error criterion function (e.g. \code{\link{ErrorCrit_RMSE}}, \code{\link{ErrorCrit_NSE}})}
\item{FUN_CALIB}{(optional) [function] calibration algorithm function (e.g. Calibration_Michel), default=Calibration_Michel} \item{FUN_CALIB}{(optional) [function] calibration algorithm function (e.g. \code{\link{Calibration_Michel}}), \code{default = Calibration_Michel}}
\item{FUN_TRANSFO}{(optional) [function] model parameters transformation function, if the FUN_MOD used is native in the package FUN_TRANSFO is automatically defined} \item{FUN_TRANSFO}{(optional) [function] model parameters transformation function, if the \code{FUN_MOD} used is native in the package \code{FUN_TRANSFO} is automatically defined}
\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} \item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default = \code{TRUE}}
} }
\value{ \value{
[list] see \code{\link{Calibration_Michel}} [list] see \code{\link{Calibration_Michel}}
} }
\description{ \description{
Calibration algorithm which optimises the error criterion selected as objective function using the provided functions. \cr Calibration algorithm which optimises the error criterion selected as objective function using the provided functions.
} }
\examples{ \examples{
library(airGR) library(airGR)
...@@ -81,9 +94,13 @@ InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_KGE, InputsModel = InputsMo ...@@ -81,9 +94,13 @@ InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_KGE, InputsModel = InputsMo
RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run])
OutputsCrit <- ErrorCrit_KGE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) OutputsCrit <- ErrorCrit_KGE(InputsCrit = InputsCrit, OutputsModel = OutputsModel)
} }
\author{ \author{
Laurent Coron (June 2014) Laurent Coron
} }
\seealso{ \seealso{
\code{\link{Calibration_Michel}}, \code{\link{Calibration_Michel}},
\code{\link{ErrorCrit}}, \code{\link{TransfoParam}}, \code{\link{ErrorCrit}}, \code{\link{TransfoParam}},
......
\encoding{UTF-8} \encoding{UTF-8}
\name{Calibration_Michel} \name{Calibration_Michel}
\alias{Calibration_Michel} \alias{Calibration_Michel}
\title{Calibration algorithm optimises the error criterion selected as objective function using the Irstea-HBAN procedure described by C. Michel} \title{Calibration algorithm optimises the error criterion selected as objective function using the Irstea-HBAN procedure described by C. Michel}
\usage{ \usage{
Calibration_Michel(InputsModel, RunOptions, InputsCrit, CalibOptions, Calibration_Michel(InputsModel, RunOptions, InputsCrit, CalibOptions,
FUN_MOD, FUN_CRIT, FUN_TRANSFO = NULL, verbose = TRUE) FUN_MOD, FUN_CRIT, FUN_TRANSFO = NULL, verbose = TRUE)
} }
\arguments{ \arguments{
\item{InputsModel}{[object of class \emph{InputsModel}] see \code{\link{CreateInputsModel}} for details} \item{InputsModel}{[object of class \emph{InputsModel}] see \code{\link{CreateInputsModel}} for details}
...@@ -15,14 +23,16 @@ Calibration_Michel(InputsModel, RunOptions, InputsCrit, CalibOptions, ...@@ -15,14 +23,16 @@ Calibration_Michel(InputsModel, RunOptions, InputsCrit, CalibOptions,
\item{CalibOptions}{[object of class \emph{CalibOptions}] see \code{\link{CreateCalibOptions}} for details} \item{CalibOptions}{[object of class \emph{CalibOptions}] see \code{\link{CreateCalibOptions}} for details}
\item{FUN_MOD}{[function] hydrological model function (e.g. RunModel_GR4J, RunModel_CemaNeigeGR4J)} \item{FUN_MOD}{[function] hydrological model function (e.g. \code{\link{RunModel_GR4J}}, \code{\link{RunModel_CemaNeigeGR4J}})}
\item{FUN_CRIT}{[function] error criterion function (e.g. ErrorCrit_RMSE, ErrorCrit_NSE)} \item{FUN_CRIT}{[function] error criterion function (e.g. \code{\link{ErrorCrit_RMSE}}, \code{\link{ErrorCrit_NSE}})}
\item{FUN_TRANSFO}{(optional) [function] model parameters transformation function, if the FUN_MOD used is native in the package FUN_TRANSFO is automatically defined} \item{FUN_TRANSFO}{(optional) [function] model parameters transformation function, if the \code{FUN_MOD} used is native in the package \code{FUN_TRANSFO} is automatically defined}
\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE} \item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default = \code{TRUE}}
} }
\value{ \value{
[list] list containing the function outputs organised as follows: [list] list containing the function outputs organised as follows:
\tabular{ll}{ \tabular{ll}{
...@@ -37,6 +47,8 @@ Calibration_Michel(InputsModel, RunOptions, InputsCrit, CalibOptions, ...@@ -37,6 +47,8 @@ Calibration_Michel(InputsModel, RunOptions, InputsCrit, CalibOptions,
\emph{$CritBestValue} \tab [numeric] theoretical best criterion value \cr \emph{$CritBestValue} \tab [numeric] theoretical best criterion value \cr
} }
} }
\description{ \description{
Calibration algorithm optimises the error criterion selected as objective function. \cr Calibration algorithm optimises the error criterion selected as objective function. \cr