Commit 749e9fa9 authored by unknown's avatar unknown
Browse files

Formatting example

parent 370aa6a7
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
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.
} }
\examples{ \examples{
require(airGR) library(airGR)
data(L0123001) data(L0123001)
str(BasinInfo) str(BasinInfo)
} }
......
...@@ -33,8 +33,9 @@ Calibration(InputsModel, RunOptions, InputsCrit, CalibOptions, FUN_MOD, ...@@ -33,8 +33,9 @@ Calibration(InputsModel, RunOptions, InputsCrit, CalibOptions, FUN_MOD,
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. \cr
} }
\examples{ \examples{
## loading catchment data
library(airGR) library(airGR)
## loading catchment data
data(L0123001) data(L0123001)
## preparation of InputsModel object ## preparation of InputsModel object
......
...@@ -61,8 +61,9 @@ the progression speed. A composite step can occasionally be done. \cr ...@@ -61,8 +61,9 @@ the progression speed. A composite step can occasionally be done. \cr
The calibration algorithm stops when the search step becomes smaller than a predefined threshold. \cr The calibration algorithm stops when the search step becomes smaller than a predefined threshold. \cr
} }
\examples{ \examples{
## loading catchment data
library(airGR) library(airGR)
## loading catchment data
data(L0123001) data(L0123001)
## preparation of InputsModel object ## preparation of InputsModel object
......
...@@ -72,8 +72,9 @@ Users wanting to use FUN_MOD, FUN_CALIB or FUN_TRANSFO functions that are not in ...@@ -72,8 +72,9 @@ Users wanting to use FUN_MOD, FUN_CALIB or FUN_TRANSFO functions that are not in
the package must create their own CalibOptions object accordingly. the package must create their own CalibOptions object accordingly.
} }
\examples{ \examples{
## loading catchment data
library(airGR) library(airGR)
## loading catchment data
data(L0123001) data(L0123001)
## preparation of InputsModel object ## preparation of InputsModel object
......
...@@ -41,8 +41,9 @@ Users wanting to use FUN_CRIT functions that are not included in ...@@ -41,8 +41,9 @@ Users wanting to use FUN_CRIT functions that are not included in
the package must create their own InputsCrit object accordingly. the package must create their own InputsCrit object accordingly.
} }
\examples{ \examples{
## loading catchment data
library(airGR) library(airGR)
## loading catchment data
data(L0123001) data(L0123001)
## preparation of the InputsModel object ## preparation of the InputsModel object
......
...@@ -49,8 +49,9 @@ Users wanting to use FUN_MOD functions that are not included in ...@@ -49,8 +49,9 @@ Users wanting to use FUN_MOD functions that are not included in
the package must create their own InputsModel object accordingly. the package must create their own InputsModel object accordingly.
} }
\examples{ \examples{
## loading catchment data
library(airGR) library(airGR)
## loading catchment data
data(L0123001) data(L0123001)
## preparation of the InputsModel object ## preparation of the InputsModel object
......
...@@ -82,8 +82,9 @@ However, it is also possible to perform a long-term initialisation if other indi ...@@ -82,8 +82,9 @@ However, it is also possible to perform a long-term initialisation if other indi
} }
} }
\examples{ \examples{
## loading catchment data
library(airGR) library(airGR)
## loading catchment data
data(L0123001) data(L0123001)
## preparation of the InputsModel object ## preparation of the InputsModel object
......
...@@ -21,8 +21,9 @@ ErrorCrit(InputsCrit, OutputsModel, FUN_CRIT, verbose = TRUE) ...@@ -21,8 +21,9 @@ ErrorCrit(InputsCrit, OutputsModel, FUN_CRIT, verbose = TRUE)
Function which computes an error criterion with the provided function. Function which computes an error criterion with the provided function.
} }
\examples{ \examples{
## loading catchment data
library(airGR) library(airGR)
## loading catchment data
data(L0123001) data(L0123001)
## preparation of the InputsModel object ## preparation of the InputsModel object
......
...@@ -19,7 +19,7 @@ PEdaily_Oudin(JD, Temp, LatRad) ...@@ -19,7 +19,7 @@ PEdaily_Oudin(JD, Temp, LatRad)
Function which computes daily PE using the formula from Oudin et al. (2005). Function which computes daily PE using the formula from Oudin et al. (2005).
} }
\examples{ \examples{
require(airGR) library(airGR)
data(L0123001) data(L0123001)
PotEvap <- PEdaily_Oudin(JD=as.POSIXlt(BasinObs$DatesR)$yday,Temp=BasinObs$T,LatRad=0.8) PotEvap <- PEdaily_Oudin(JD=as.POSIXlt(BasinObs$DatesR)$yday,Temp=BasinObs$T,LatRad=0.8)
} }
......
...@@ -21,8 +21,9 @@ RunModel(InputsModel, RunOptions, Param, FUN_MOD) ...@@ -21,8 +21,9 @@ RunModel(InputsModel, RunOptions, Param, FUN_MOD)
Function which performs a single model run with the provided function over the selected period. Function which performs a single model run with the provided function over the selected period.
} }
\examples{ \examples{
## loading catchment data
library(airGR) library(airGR)
## loading catchment data
data(L0123001) data(L0123001)
## preparation of the InputsModel object ## preparation of the InputsModel object
......
...@@ -41,8 +41,9 @@ For further details on the model, see the references section. ...@@ -41,8 +41,9 @@ For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
} }
\examples{ \examples{
library(airGR)
## load of catchment data ## load of catchment data
require(airGR)
data(L0123002) data(L0123002)
## preparation of the InputsModel object ## preparation of the InputsModel object
......
...@@ -59,8 +59,9 @@ For further details on the model, see the references section. ...@@ -59,8 +59,9 @@ For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
} }
\examples{ \examples{
## loading catchment data
library(airGR) library(airGR)
## loading catchment data
data(L0123002) data(L0123002)
## preparation of the InputsModel object ## preparation of the InputsModel object
......
...@@ -60,8 +60,9 @@ For further details on the model, see the references section. ...@@ -60,8 +60,9 @@ For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
} }
\examples{ \examples{
## loading catchment data
library(airGR) library(airGR)
## loading catchment data
data(L0123002) data(L0123002)
## preparation of the InputsModel object ## preparation of the InputsModel object
......
...@@ -63,8 +63,9 @@ For further details on the model, see the references section. ...@@ -63,8 +63,9 @@ For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
} }
\examples{ \examples{
## loading catchment data
library(airGR) library(airGR)
## loading catchment data
data(L0123002) data(L0123002)
## preparation of the InputsModel object ## preparation of the InputsModel object
......
...@@ -34,8 +34,9 @@ For further details on the model, see the references section. ...@@ -34,8 +34,9 @@ For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
} }
\examples{ \examples{
## loading catchment data
library(airGR) library(airGR)
## loading catchment data
data(L0123001) data(L0123001)
## conversion of example data from daily to yearly time step ## conversion of example data from daily to yearly time step
......
...@@ -35,8 +35,9 @@ For further details on the model, see the references section. ...@@ -35,8 +35,9 @@ For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
} }
\examples{ \examples{
## loading catchment data
library(airGR) library(airGR)
## loading catchment data
data(L0123001) data(L0123001)
## conversion of example data from daily to monthly time step ## conversion of example data from daily to monthly time step
......
...@@ -48,8 +48,9 @@ For further details on the model, see the references section. ...@@ -48,8 +48,9 @@ For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
} }
\examples{ \examples{
library(airGR)
## load of catchment data ## load of catchment data
require(airGR)
data(L0123003) data(L0123003)
## preparation of the InputsModel object ## preparation of the InputsModel object
......
...@@ -48,8 +48,9 @@ For further details on the model, see the references section. ...@@ -48,8 +48,9 @@ For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
} }
\examples{ \examples{
## loading catchment data
library(airGR) library(airGR)
## loading catchment data
data(L0123001) data(L0123001)
## preparation of the InputsModel object ## preparation of the InputsModel object
......
...@@ -49,8 +49,9 @@ For further details on the model, see the references section. ...@@ -49,8 +49,9 @@ For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
} }
\examples{ \examples{
## loading catchment data
library(airGR) library(airGR)
## loading catchment data
data(L0123001) data(L0123001)
## preparation of the InputsModel object ## preparation of the InputsModel object
......
...@@ -52,8 +52,9 @@ For further details on the model, see the references section. ...@@ -52,8 +52,9 @@ For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}. For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
} }
\examples{ \examples{
## loading catchment data
library(airGR) library(airGR)
## loading catchment data
data(L0123001) data(L0123001)
## preparation of the InputsModel object ## preparation of the InputsModel object
......
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