Commit 782f917f authored by Delaigue Olivier's avatar Delaigue Olivier
Browse files

v1.2.11.16 DOC:only one help page for all TransfoParam* funs

parent 1c9553e7
Package: airGR
Type: Package
Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
Version: 1.2.11.15
Date: 2019-03-26
Version: 1.2.11.16
Date: 2019-03-27
Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),
person("Charles", "Perrin", role = c("aut", "ths"), comment = c(ORCID = "0000-0001-8552-1881")),
......
......@@ -13,7 +13,7 @@ output:
### 1.2.11.15 Release Notes (2019-03-26)
### 1.2.11.16 Release Notes (2019-03-27)
......
......@@ -139,7 +139,7 @@ Michel, C. (1991),
\seealso{
\code{\link{Calibration}},
\code{\link{RunModel_GR4J}}, \code{\link{TransfoParam_GR4J}}, \code{\link{ErrorCrit_RMSE}},
\code{\link{RunModel_GR4J}}, \code{\link{TransfoParam}}, \code{\link{ErrorCrit_RMSE}},
\code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}},
\code{\link{CreateInputsCrit}}, \code{\link{CreateCalibOptions}}.
}
......
......@@ -3,13 +3,32 @@
\name{TransfoParam}
\alias{TransfoParam}
\alias{TransfoParam_GR1A}
\alias{TransfoParam_GR2M}
\alias{TransfoParam_GR4J}
\alias{TransfoParam_GR5J}
\alias{TransfoParam_GR6J}
\alias{TransfoParam_GR4H}
\alias{TransfoParam_CemaNeige}
\alias{TransfoParam_CemaNeigeHyst}
\title{Transformation of the parameters using the provided function}
\usage{
## Generic function
TransfoParam(ParamIn, Direction, FUN_TRANSFO)
## Specific functions
TransfoParam_GR1A(ParamIn, Direction)
TransfoParam_GR2M(ParamIn, Direction)
TransfoParam_GR4J(ParamIn, Direction)
TransfoParam_GR5J(ParamIn, Direction)
TransfoParam_GR6J(ParamIn, Direction)
TransfoParam_GR4H(ParamIn, Direction)
TransfoParam_CemaNeige(ParamIn, Direction)
TransfoParam_CemaNeigeHyst(ParamIn, Direction)
}
......@@ -33,6 +52,9 @@ Function which transforms model parameters using the provided function (from raw
\examples{
library(airGR)
#### generic function
## transformation Raw -> Transformed for the GR4J model
Xraw <- matrix(c(+221.41, -3.63, +30.00, +1.37,
+347.23, -1.03, +60.34, +1.76,
......@@ -46,6 +68,23 @@ Xtran <- matrix(c(+3.60, -2.00, +3.40, -9.10,
+4.50, -0.10, +5.00, -8.10),
ncol = 4, byrow = TRUE)
Xraw <- TransfoParam(ParamIn = Xtran, Direction = "TR", FUN_TRANSFO = TransfoParam_GR4J)
#### specific function
## transformation Raw -> Transformed for the GR4J model
Xraw <- matrix(c(+221.41, -3.63, +30.00, +1.37,
+347.23, -1.03, +60.34, +1.76,
+854.06, -0.10, +148.41, +2.34),
ncol = 4, byrow = TRUE)
Xtran <- TransfoParam_GR4J(ParamIn = Xraw , Direction = "RT")
## transformation Transformed -> Raw for the GR4J model
Xtran <- matrix(c(+3.60, -2.00, +3.40, -9.10,
+3.90, -0.90, +4.10, -8.70,
+4.50, -0.10, +5.00, -8.10),
ncol = 4, byrow = TRUE)
Xraw <- TransfoParam_GR4J(ParamIn = Xtran, Direction = "TR")
}
......@@ -54,7 +93,4 @@ Laurent Coron
}
\seealso{
\code{\link{TransfoParam_GR4J}}, \code{\link{TransfoParam_GR5J}}, \code{\link{TransfoParam_GR6J}}, \code{\link{TransfoParam_CemaNeige}}
}
\encoding{UTF-8}
\name{TransfoParam_CemaNeige}
\alias{TransfoParam_CemaNeige}
\title{Transformation of the parameters of the CemaNeige module}
\usage{
TransfoParam_CemaNeige(ParamIn, Direction)
}
\arguments{
\item{ParamIn}{[numeric] vector or matrix of parameter sets (if matrix: sets in line, parameter values in column)}
\item{Direction}{[character] direction of the transformation: use \code{"RT"} for Raw -> Transformed and \code{"TR"} for Transformed -> Raw}
}
\value{
\emph{ParamOut} [numeric] matrix of parameter sets (sets in line, parameter values in column)
}
\description{
Function which transforms model parameters of the CemaNeige module (from raw to transformed parameters and vice versa).
}
\examples{
library(airGR)
## transformation Raw -> Transformed for the CemaNeige module
Xraw <- matrix(c(+0.19, +1.73,
+0.39, +2.51,
+0.74, +4.06),
ncol = 2, byrow = TRUE)
Xtran <- TransfoParam_CemaNeige(ParamIn = Xraw , Direction = "RT")
## transformation Transformed -> Raw for the CemaNeige module
Xtran <- matrix(c(-6.26, +0.55,
-2.13, +0.92,
+4.86, +1.40),
ncol = 2, byrow = TRUE)
Xraw <- TransfoParam_CemaNeige(ParamIn = Xtran, Direction = "TR")
}
\author{
Laurent Coron
}
\seealso{
\code{\link{TransfoParam}}, \code{\link{TransfoParam_GR4J}}, \code{\link{TransfoParam_GR5J}}, \code{\link{TransfoParam_GR6J}}
}
\encoding{UTF-8}
\name{TransfoParam_GR1A}
\alias{TransfoParam_GR1A}
\title{Transformation of the parameters of the GR1A model}
\usage{
TransfoParam_GR1A(ParamIn, Direction)
}
\arguments{
\item{ParamIn}{[numeric] matrix of parameter sets (sets in line, parameter values in column)}
\item{Direction}{[character] direction of the transformation: use \code{"RT"} for Raw -> Transformed and \code{"TR"} for Transformed -> Raw}
}
\value{
\emph{ParamOut} [numeric] matrix of parameter sets (sets in line, parameter values in column)
}
\description{
Function which transforms model parameters of the GR1A model (from real to transformed parameters and vice versa).
}
\author{
Laurent Coron
}
\encoding{UTF-8}
\name{TransfoParam_GR2M}
\alias{TransfoParam_GR2M}
\title{Transformation of the parameters of the GR2M model}
\usage{
TransfoParam_GR2M(ParamIn, Direction)
}
\arguments{
\item{ParamIn}{[numeric] matrix of parameter sets (sets in line, parameter values in column)}
\item{Direction}{[character] direction of the transformation: use \code{"RT"} for Raw -> Transformed and \code{"TR"} for Transformed -> Raw}
}
\value{
\emph{ParamOut} [numeric] matrix of parameter sets (sets in line, parameter values in column)
}
\description{
Function which transforms model parameters of the GR2M model (from real to transformed parameters and vice versa).
}
\author{
Laurent Coron
}
\encoding{UTF-8}
\name{TransfoParam_GR4H}
\alias{TransfoParam_GR4H}
\title{Transformation of the parameters of the GR4H model}
\usage{
TransfoParam_GR4H(ParamIn, Direction)
}
\arguments{
\item{ParamIn}{[numeric] matrix of parameter sets (sets in line, parameter values in column)}
\item{Direction}{[character] direction of the transformation: use \code{"RT"} for Raw -> Transformed and \code{"TR"} for Transformed -> Raw}
}
\value{
\emph{ParamOut} [numeric] matrix of parameter sets (sets in line, parameter values in column)
}
\description{
Function which transforms model parameters of the GR4H model (from real to transformed parameters and vice versa).
}
\author{
Laurent Coron, Claude Michel, Thibault Mathevet
}
\encoding{UTF-8}
\name{TransfoParam_GR4J}
\alias{TransfoParam_GR4J}
\title{Transformation of the parameters of the GR4J model}
\usage{
TransfoParam_GR4J(ParamIn, Direction)
}
\arguments{
\item{ParamIn}{[numeric] matrix of parameter sets (sets in line, parameter values in column)}
\item{Direction}{[character] direction of the transformation: use \code{"RT"} for Raw -> Transformed and \code{"TR"} for Transformed -> Raw}
}
\value{
\emph{ParamOut} [numeric] matrix of parameter sets (sets in line, parameter values in column)
}
\description{
Function which transforms model parameters of the GR4J model (from real to transformed parameters and vice versa).
}
\examples{
library(airGR)
## transformation Raw -> Transformed for the GR4J model
Xraw <- matrix(c(+221.41, -3.63, +30.00, +1.37,
+347.23, -1.03, +60.34, +1.76,
+854.06, -0.10, +148.41, +2.34),
ncol = 4, byrow = TRUE)
Xtran <- TransfoParam_GR4J(ParamIn = Xraw , Direction = "RT")
## transformation Transformed -> Raw for the GR4J model
Xtran <- matrix(c(+3.60, -2.00, +3.40, -9.10,
+3.90, -0.90, +4.10, -8.70,
+4.50, -0.10, +5.00, -8.10),
ncol = 4, byrow = TRUE)
Xraw <- TransfoParam_GR4J(ParamIn = Xtran, Direction = "TR")
}
\author{
Laurent Coron
}
\seealso{
\code{\link{TransfoParam}}, \code{\link{TransfoParam_GR5J}}, \code{\link{TransfoParam_GR6J}}, \code{\link{TransfoParam_CemaNeige}}
}
\encoding{UTF-8}
\name{TransfoParam_GR5J}
\alias{TransfoParam_GR5J}
\title{Transformation of the parameters of the GR5J model}
\usage{
TransfoParam_GR5J(ParamIn, Direction)
}
\arguments{
\item{ParamIn}{[numeric] matrix of parameter sets (sets in line, parameter values in column)}
\item{Direction}{[character] direction of the transformation: use \code{"RT"} for Raw -> Transformed and \code{"TR"} for Transformed -> Raw}
}
\value{
\emph{ParamOut} [numeric] matrix of parameter sets (sets in line, parameter values in column)
}
\description{
Function which transforms model parameters of the GR5J model (from real to transformed parameters and vice versa).
}
\examples{
library(airGR)
## transformation Raw -> Transformed for the GR5J model
Xraw <- matrix(c(+221.41, -2.65, +27.11, +1.37, -0.76,
+347.23, -0.64, +60.34, +1.76, +0.30,
+854.01, -0.10, +148.41, +2.34, +0.52),
ncol = 5, byrow = TRUE)
Xtran <- TransfoParam_GR5J(ParamIn = Xraw , Direction = "RT")
## transformation Transformed -> Raw for the GR5J model
Xtran <- matrix(c(+3.60, -1.70, +3.30, -9.10, -0.70,
+3.90, -0.60, +4.10, -8.70, +0.30,
+4.50, -0.10, +5.00, -8.10, +0.50),
ncol = 5, byrow = TRUE)
Xraw <- TransfoParam_GR5J(ParamIn = Xtran, Direction = "TR")
}
\author{
Laurent Coron
}
\seealso{
\code{\link{TransfoParam}}, \code{\link{TransfoParam_GR4J}}, \code{\link{TransfoParam_GR6J}}, \code{\link{TransfoParam_CemaNeige}}
}
\encoding{UTF-8}
\name{TransfoParam_GR6J}
\alias{TransfoParam_GR6J}
\title{Transformation of the parameters of the GR6J model}
\usage{
TransfoParam_GR6J(ParamIn, Direction)
}
\arguments{
\item{ParamIn}{[numeric] matrix of parameter sets (sets in line, parameter values in column)}
\item{Direction}{[character] direction of the transformation: use \code{"RT"} for Raw -> Transformed and \code{"TR"} for Transformed -> Raw}
}
\value{
\emph{ParamOut} [numeric] matrix of parameter sets (sets in line, parameter values in column)
}
\description{
Function which transforms model parameters of the GR6J model (from real to transformed parameters and vice versa).
}
\examples{
library(airGR)
## transformation Raw -> Transformed for the GR6J model
Xraw <- matrix(c(+221.41, -1.18, +27.11, 1.37, -0.18, +20.09,
+347.23, -0.52, +60.34, 1.76, +0.02, +54.60,
+854.06, +0.52, +148.41, 2.34, +0.22, +148.41),
ncol = 6, byrow = TRUE)
Xtran <- TransfoParam_GR6J(ParamIn = Xraw , Direction = "RT")
## transformation Transformed -> Raw for the GR6J model
Xtran <- matrix(c(+3.60, -1.00, +3.30, -9.10, -0.90, +3.00,
+3.90, -0.50, +4.10, -8.70, +0.10, +4.00,
+4.50, +0.50, +5.00, -8.10, +1.10, +5.00),
ncol = 6, byrow = TRUE)
Xraw <- TransfoParam_GR6J(ParamIn = Xtran, Direction = "TR")
}
\author{
Laurent Coron
}
\seealso{
\code{\link{TransfoParam}}, \code{\link{TransfoParam_GR4J}}, \code{\link{TransfoParam_GR5J}}, \code{\link{TransfoParam_CemaNeige}}
}
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