diff --git a/DESCRIPTION b/DESCRIPTION index 3fef612fc1167921ab533121ae7cefd0cb22e808..d123a3efa8914fe55ffdb729efc446be32ce6d6e 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,8 @@ 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")), diff --git a/NEWS.rmd b/NEWS.rmd index 8ba522336a064451820f2d6155abf6992da2fea4..97cc789371635d60fc1eab6da06360afdc1288e3 100644 --- a/NEWS.rmd +++ b/NEWS.rmd @@ -13,7 +13,7 @@ output: -### 1.2.11.15 Release Notes (2019-03-26) +### 1.2.11.16 Release Notes (2019-03-27) diff --git a/man/Calibration_Michel.Rd b/man/Calibration_Michel.Rd index a1961b8127b75f4c38fba394d90f88d237d0c7e9..c664e7993c6c444a8f4114ef8945ddc46c7dcacb 100644 --- a/man/Calibration_Michel.Rd +++ b/man/Calibration_Michel.Rd @@ -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}}. } diff --git a/man/TransfoParam.Rd b/man/TransfoParam.Rd index b1410dff368c803f5a220dfeda25c3c2766cd1bc..be9254d03c56d6275d1b84d42ef3573163a410cc 100644 --- a/man/TransfoParam.Rd +++ b/man/TransfoParam.Rd @@ -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}} -} diff --git a/man/TransfoParam_CemaNeige.Rd b/man/TransfoParam_CemaNeige.Rd deleted file mode 100644 index 590c376f035d9663389b168d3d6aa6df420c89f9..0000000000000000000000000000000000000000 --- a/man/TransfoParam_CemaNeige.Rd +++ /dev/null @@ -1,60 +0,0 @@ -\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}} -} - diff --git a/man/TransfoParam_GR1A.Rd b/man/TransfoParam_GR1A.Rd deleted file mode 100644 index f229b80dc15758b060059cda06ace112afa3900b..0000000000000000000000000000000000000000 --- a/man/TransfoParam_GR1A.Rd +++ /dev/null @@ -1,36 +0,0 @@ -\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 -} - diff --git a/man/TransfoParam_GR2M.Rd b/man/TransfoParam_GR2M.Rd deleted file mode 100644 index fd6164dbdc0417e7ab7d925ab70b651aec42d8ee..0000000000000000000000000000000000000000 --- a/man/TransfoParam_GR2M.Rd +++ /dev/null @@ -1,34 +0,0 @@ -\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 -} - diff --git a/man/TransfoParam_GR4H.Rd b/man/TransfoParam_GR4H.Rd deleted file mode 100644 index ed92501c1c771d421996a70786a0987b580df018..0000000000000000000000000000000000000000 --- a/man/TransfoParam_GR4H.Rd +++ /dev/null @@ -1,34 +0,0 @@ -\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 -} - diff --git a/man/TransfoParam_GR4J.Rd b/man/TransfoParam_GR4J.Rd deleted file mode 100644 index e0c7383e5aafb7a58d5125a5fd8bcae23a621ba5..0000000000000000000000000000000000000000 --- a/man/TransfoParam_GR4J.Rd +++ /dev/null @@ -1,60 +0,0 @@ -\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}} -} - diff --git a/man/TransfoParam_GR5J.Rd b/man/TransfoParam_GR5J.Rd deleted file mode 100644 index 7e09bffdb9e8cc0c05e1819fe82d4818c0ea0054..0000000000000000000000000000000000000000 --- a/man/TransfoParam_GR5J.Rd +++ /dev/null @@ -1,60 +0,0 @@ -\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}} -} - diff --git a/man/TransfoParam_GR6J.Rd b/man/TransfoParam_GR6J.Rd deleted file mode 100644 index 47d290db4c756751de6d569664196ed0ce7db7f3..0000000000000000000000000000000000000000 --- a/man/TransfoParam_GR6J.Rd +++ /dev/null @@ -1,60 +0,0 @@ -\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}} -} -