diff --git a/R/Calibration.GriwrmInputsModel.R b/R/Calibration.GriwrmInputsModel.R index 9831538f656b748dd641e00a91f3fc4a6e5e4b0e..aa90a70a71325db6a27ce174886450dd88ea038e 100644 --- a/R/Calibration.GriwrmInputsModel.R +++ b/R/Calibration.GriwrmInputsModel.R @@ -1,16 +1,16 @@ #' Calibration of a semi-distributed run-off model #' -#' @param InputsModel object of class \emph{GriwrmInputsModel}, see \code{\link{CreateInputsModel.GRiwrm}} for details. -#' @param RunOptions object of class \emph{GriwrmRunOptions}, see \code{\link{CreateRunOptiosn.GRiwrm}} for details. -#' @param InputsCrit object of class \emph{GriwrmInputsCrit}, see \code{\link{CreateInputsCrit.GRiwrm}} for details. -#' @param CalibOptions object of class \emph{GriwrmCalibOptions}, see \code{\link{CreateCalibOptions.GRiwrm}} for details. +#' @param InputsModel object of class \emph{GRiwrmInputsModel}, see \code{\link{CreateInputsModel.GRiwrm}} for details. +#' @param RunOptions object of class \emph{GRiwrmRunOptions}, see \code{\link{CreateRunOptiosn.GRiwrm}} for details. +#' @param InputsCrit object of class \emph{GRiwrmInputsCrit}, see \code{\link{CreateInputsCrit.GRiwrm}} for details. +#' @param CalibOptions object of class \emph{GRiwrmCalibOptions}, see \code{\link{CreateCalibOptions.GRiwrm}} for details. #' @param useUpstreamQsim boolean describing if simulated (\code{TRUE}) or observed (\code{FALSE}) flows are used for calibration. Default is \code{TRUE}. #' @param verbose (optional) boolean indicating if the function is run in verbose mode or not, default = \code{TRUE} #' @param ... further arguments passed to \code{\link[airGR]{Calibration}}. #' -#' @return GriwrmOutputsCalib object which is a list of OutputsCalib (See \code{\link[airGR]{Calibration}}) for each node of the semi-distributed model. +#' @return GRiwrmOutputsCalib object which is a list of OutputsCalib (See \code{\link[airGR]{Calibration}}) for each node of the semi-distributed model. #' @export -Calibration.GriwrmInputsModel <- function(InputsModel, +Calibration.GRiwrmInputsModel <- function(InputsModel, RunOptions, InputsCrit, CalibOptions, @@ -19,13 +19,13 @@ Calibration.GriwrmInputsModel <- function(InputsModel, ...) { OutputsCalib <- list() - class(OutputsCalib) <- append(class(OutputsCalib), "GriwrmOutputsCalib") + class(OutputsCalib) <- append(class(OutputsCalib), "GRiwrmOutputsCalib") OutputsModel <- list() - class(OutputsModel) <- append(class(OutputsModel), "GriwrmOutputsModel") + class(OutputsModel) <- append(class(OutputsModel), "GRiwrmOutputsModel") for(IM in InputsModel) { - if(verbose) cat("Calibration.GriwrmInputsModel: Treating sub-basin", IM$id, "...\n") + if(verbose) cat("Calibration.GRiwrmInputsModel: Treating sub-basin", IM$id, "...\n") if(useUpstreamQsim) { # Update InputsModel$Qupstream with simulated upstream flows diff --git a/R/Calibration.R b/R/Calibration.R index 04b76e1e56aa70fc691a405b93f88f42033b59dd..a924f2e2df38e34ff81ef73788b9bcfb63a41b1f 100644 --- a/R/Calibration.R +++ b/R/Calibration.R @@ -3,7 +3,7 @@ #' @param InputsModel the class of the first parameter determine which calibration is used #' @param ... further arguments passed to or from other methods. #' -#' @return \emph{OutputsCalib} or \emph{GriwrmOutputsCalib} object +#' @return \emph{OutputsCalib} or \emph{GRiwrmOutputsCalib} object #' @export Calibration <- function(InputsModel, ...) { UseMethod("Calibration", InputsModel) diff --git a/R/CreateCalibOptions.GriwrmInputsModel.R b/R/CreateCalibOptions.GriwrmInputsModel.R index 3d0a09844e5083a537b8b5f212be9d23091f481b..3c0d16809be92e2b01f47d36e8662103c849073f 100644 --- a/R/CreateCalibOptions.GriwrmInputsModel.R +++ b/R/CreateCalibOptions.GriwrmInputsModel.R @@ -1,11 +1,11 @@ #' Title #' -#' @param InputsModel object of class \emph{GriwrmInputsModel}, see \code{\link{CreateInputsModel.GRiwrm}} for details. +#' @param InputsModel object of class \emph{GRiwrmInputsModel}, see \code{\link{CreateInputsModel.GRiwrm}} for details. #' @param ... further arguments passed to \code{\link[airGR]{CreateCalibOptions}}. #' -#' @return \emph{GriwrmCalibOptions} object. +#' @return \emph{GRiwrmCalibOptions} object. #' @export -CreateCalibOptions.GriwrmInputsModel <- function(InputsModel, ...) { +CreateCalibOptions.GRiwrmInputsModel <- function(InputsModel, ...) { CalibOptions <- list() diff --git a/R/CreateInputsCrit.GriwrmInputsModel.R b/R/CreateInputsCrit.GriwrmInputsModel.R index 475309b97055934f96b1532ada60ab558de88dcf..34a64efbd634a60003bf7e8f0a1432001969290a 100644 --- a/R/CreateInputsCrit.GriwrmInputsModel.R +++ b/R/CreateInputsCrit.GriwrmInputsModel.R @@ -1,19 +1,19 @@ -#' Create \emph{GriwrmInputsCrit} object for GR-IWRM. -#' @param InputsModel object of class \emph{GriwrmInputsModel}, see \code{\link{CreateInputsModel.GRiwrm}} for details. +#' Create \emph{GRiwrmInputsCrit} object for GR-IWRM. +#' @param InputsModel object of class \emph{GRiwrmInputsModel}, see \code{\link{CreateInputsModel.GRiwrm}} for details. #' @param FUN_CRIT \[function (atomic or list)\] error criterion function (e.g. \code{\link[airGR]{ErrorCrit_RMSE}}, \code{\link[airGR]{ErrorCrit_NSE}}) -#' @param RunOptions object of class \emph{GriwrmRunOptions}, see \code{[CreateRunOptions.GRiwrm]} for details. +#' @param RunOptions object of class \emph{GRiwrmRunOptions}, see \code{[CreateRunOptions.GRiwrm]} for details. #' @param Qobs matrix or data frame containing observed flows. Column names correspond to nodes ID #' @param ... further arguments passed to \code{\link[airGR]{CreateInputsCrit}}. #' -#' @return Object of class \emph{GriwrmInputsCrit} +#' @return Object of class \emph{GRiwrmInputsCrit} #' @export -CreateInputsCrit.GriwrmInputsModel <- function(InputsModel, +CreateInputsCrit.GRiwrmInputsModel <- function(InputsModel, FUN_CRIT = airGR::ErrorCrit_NSE, RunOptions, Qobs, ...) { InputsCrit <- list() - class(InputsCrit) <- append(class(InputsCrit), "GriwrmInputsCrit") + class(InputsCrit) <- append(class(InputsCrit), "GRiwrmInputsCrit") for(IM in InputsModel) { InputsCrit[[IM$id]] <- CreateInputsCrit.InputsModel( diff --git a/R/CreateInputsModel.Griwrm.R b/R/CreateInputsModel.Griwrm.R index 46bf9bbf61b0c44e6e6a5b09c77e58d7e0942d74..6401d309fe1a5130bb6b101e4c0e994f28de253e 100644 --- a/R/CreateInputsModel.Griwrm.R +++ b/R/CreateInputsModel.Griwrm.R @@ -8,16 +8,16 @@ #' @param verbose (optional) boolean indicating if the function is run in verbose mode or not, default = \code{TRUE} #' @param ... further arguments passed to \code{\link[airGR]{CreateInputsModel}}. #' -#' @return GriwrmInputsModel object equivalent to airGR InputsModel object for a semi-distributed model (See \code{\link[airGR]{CreateInputsModel}}) +#' @return GRiwrmInputsModel object equivalent to airGR InputsModel object for a semi-distributed model (See \code{\link[airGR]{CreateInputsModel}}) #' @export CreateInputsModel.GRiwrm <- function(x, DatesR, Precip, PotEvap, Qobs, verbose = TRUE, ...) { - InputsModel <- CreateEmptyGriwrmInputsModel() + InputsModel <- CreateEmptyGRiwrmInputsModel() Qobs[is.na(Qobs)] <- -99 # airGRCreateInputsModel doesn't accept NA values for(id in getNodeRanking(x)) { if(verbose) cat("CreateInputsModel.griwrm: Treating sub-basin", id, "...\n") - InputsModel[[id]] <- CreateOneGriwrmInputsModel( + InputsModel[[id]] <- CreateOneGRiwrmInputsModel( id, x, DatesR,Precip[,id], PotEvap[,id], Qobs, ... ) } @@ -27,10 +27,10 @@ CreateInputsModel.GRiwrm <- function(x, DatesR, Precip, PotEvap, Qobs, verbose = #' Create an empty InputsModel object for GRIWRM nodes #' -#' @return \emph{GriwrmInputsModel} empty object -CreateEmptyGriwrmInputsModel <- function() { +#' @return \emph{GRiwrmInputsModel} empty object +CreateEmptyGRiwrmInputsModel <- function() { InputsModel <- list() - class(InputsModel) <- append(class(InputsModel), "GriwrmInputsModel") + class(InputsModel) <- append(class(InputsModel), "GRiwrmInputsModel") return(InputsModel) } @@ -45,7 +45,7 @@ CreateEmptyGriwrmInputsModel <- function() { #' @param Qobs Matrix or data frame of numeric containing observed flow (mm/time step). Column names correspond to node IDs. ##' #' @return \emph{InputsModel} object for one. -CreateOneGriwrmInputsModel <- function(id, griwrm, DatesR, Precip, PotEvap, Qobs) { +CreateOneGRiwrmInputsModel <- function(id, griwrm, DatesR, Precip, PotEvap, Qobs) { node <- griwrm[griwrm$id == id,] FUN_MOD <- griwrm$model[griwrm$id == id] diff --git a/R/CreateInputsModel.R b/R/CreateInputsModel.R index 5e7012b48e81a60759cfbb15460da712af9c55ac..4e2b954d57a1719ddebcbf5f8896e26b22c8a5a8 100644 --- a/R/CreateInputsModel.R +++ b/R/CreateInputsModel.R @@ -3,7 +3,7 @@ #' @param x First parameter determining which InputsModel object is created #' @param ... further arguments passed to or from other methods. #' -#' @return InputsModel or GriwrmInputsObject object +#' @return InputsModel or GRiwrmInputsObject object #' @export CreateInputsModel <- function(x, ...) { UseMethod("CreateInputsModel", x) diff --git a/R/CreateRunOptions.GriwrmInputsModel.R b/R/CreateRunOptions.GriwrmInputsModel.R index 21fee4003a07318eb489ef53734ee07622b8b58f..da37cca770289adfee2b07745cfa2e9f5fa597b0 100644 --- a/R/CreateRunOptions.GriwrmInputsModel.R +++ b/R/CreateRunOptions.GriwrmInputsModel.R @@ -1,14 +1,14 @@ -#' Create \emph{GriwrmRunOptions} object for running and calibrating model in GR-IWRM. +#' Create \emph{GRiwrmRunOptions} object for running and calibrating model in GR-IWRM. #' -#' @param InputsModel object of class \emph{GriwrmInputsModel}, see \code{\link{CreateInputsModel.GRiwrm}} for details. +#' @param InputsModel object of class \emph{GRiwrmInputsModel}, see \code{\link{CreateInputsModel.GRiwrm}} for details. #' @param ... further arguments passed to \code{\link[airGR]{CreateOptions}}. #' -#' @return \emph{GriwrmRunOptions} object for running and calibrating model in GR-IWRM. +#' @return \emph{GRiwrmRunOptions} object for running and calibrating model in GR-IWRM. #' @export -CreateRunOptions.GriwrmInputsModel <- function(InputsModels, ...) { +CreateRunOptions.GRiwrmInputsModel <- function(InputsModels, ...) { RunOptions <- list() - class(RunOptions) <- append(class(RunOptions), "GriwrmRunOptions") + class(RunOptions) <- append(class(RunOptions), "GRiwrmRunOptions") for(InputsModelBasin in InputsModels) { RunOptions[[InputsModelBasin$id]] <- CreateRunOptions(InputsModel = InputsModelBasin, ...) diff --git a/R/CreateRunOptions.R b/R/CreateRunOptions.R index 394c1795eb52a920d57315f87a230cc8e5951400..67b6d018a82072bd97bf55d8fd3a4008aa184306 100644 --- a/R/CreateRunOptions.R +++ b/R/CreateRunOptions.R @@ -1,6 +1,6 @@ -#' Create \emph{RunOptions} object for airGR and GR-IWRM. See \code{\link[airGR]{CreateOptions}} and \code{[CreateOptions.GriwrmInputsModel]}. +#' Create \emph{RunOptions} object for airGR and GR-IWRM. See \code{\link[airGR]{CreateOptions}} and \code{[CreateOptions.GRiwrmInputsModel]}. #' -#' @param InputsModel object of class \emph{InputsModel} (see \code{\link[airGR]{CreateInputsModel}}) or \emph{GriwrmInputsModel} (See \code{[CreateInputsModel.GRiwrm]}). +#' @param InputsModel object of class \emph{InputsModel} (see \code{\link[airGR]{CreateInputsModel}}) or \emph{GRiwrmInputsModel} (See \code{[CreateInputsModel.GRiwrm]}). #' @param ... further arguments passed to or from other methods. #' #' @return Object of \emph{RunOptions} class family diff --git a/R/DiagramGriwrm.R b/R/DiagramGriwrm.R index ff812207c5fdb421f5ed2c1cca827507167a6b56..72127abe05e866f82379a595e91b8eb9c47720f3 100644 --- a/R/DiagramGriwrm.R +++ b/R/DiagramGriwrm.R @@ -14,12 +14,12 @@ #' @examples #' \dontrun{ #' # Display diagram -#' DiagramGriwrm(griwrm) +#' DiagramGRiwrm(griwrm) #' # Is the same as -#' DiagrammeR::mermaid(DiagramGriwrm(griwrm, display = FALSE), width = "100%", height = "100%") +#' DiagrammeR::mermaid(DiagramGRiwrm(griwrm, display = FALSE), width = "100%", height = "100%") #' } #' -DiagramGriwrm <- function(griwrm, display = TRUE, orientation = "LR") { +DiagramGRiwrm <- function(griwrm, display = TRUE, orientation = "LR") { if(Sys.getenv("RSTUDIO") != "1") { return() } diff --git a/R/RunModel.GriwrmInputsModel.R b/R/RunModel.GriwrmInputsModel.R index 0613cf8622ee82a71c6289daf905a5451b070af9..85c1842cb0f5c95d74a9f07a40ff30d02362e48e 100644 --- a/R/RunModel.GriwrmInputsModel.R +++ b/R/RunModel.GriwrmInputsModel.R @@ -1,20 +1,20 @@ #' Title #' -#' @param InputsModel object of class \emph{GriwrmInputsModel}, see \code{[CreateInputsModel.GRiwrm]} for details. -#' @param RunOptions object of class \emph{GriwrmRunOptions}, see \code{[CreateRunOptions.GRiwrm]} for details. +#' @param InputsModel object of class \emph{GRiwrmInputsModel}, see \code{[CreateInputsModel.GRiwrm]} for details. +#' @param RunOptions object of class \emph{GRiwrmRunOptions}, see \code{[CreateRunOptions.GRiwrm]} for details. #' @param Param list of parameter. The list item names are the IDs of the sub-basins. Each item is a vector of numerical parameters. #' @param verbose (optional) boolean indicating if the function is run in verbose mode or not, default = \code{TRUE} #' @param ... Mandatory for S3 method signature function compatibility with generic. #' -#' @return \emph{GriwrmOutputsModel} object which is a list of \emph{OutputsModel} objects (See \code{\link[airGR]{RunModel}}) for each node of the semi-distributed model. +#' @return \emph{GRiwrmOutputsModel} object which is a list of \emph{OutputsModel} objects (See \code{\link[airGR]{RunModel}}) for each node of the semi-distributed model. #' @export -RunModel.GriwrmInputsModel <- function(InputsModel, RunOptions, Param, verbose = TRUE, ...) { +RunModel.GRiwrmInputsModel <- function(InputsModel, RunOptions, Param, verbose = TRUE, ...) { OutputsModel <- list() - class(OutputsModel) <- append(class(OutputsModel), "GriwrmOutputsModel") + class(OutputsModel) <- append(class(OutputsModel), "GRiwrmOutputsModel") for(IM in InputsModel) { - if(verbose) cat("RunModel.GriwrmInputsModel: Treating sub-basin", IM$id, "...\n") + if(verbose) cat("RunModel.GRiwrmInputsModel: Treating sub-basin", IM$id, "...\n") # Update InputsModel$Qupstream with simulated upstream flows IM <- UpdateQsimUpstream(IM, RunOptions[[IM$id]]$IndPeriod_Run, OutputsModel) diff --git a/R/RunModel.R b/R/RunModel.R index fdd50dce2960cce3ccc3839af2cd2cb15e0a7f8b..2066e6f7398803b05f3a2dd1dbd2bd9d49190d53 100644 --- a/R/RunModel.R +++ b/R/RunModel.R @@ -1,4 +1,4 @@ -#' RunModel function for both airGR and GriwrmInputsModel object +#' RunModel function for both airGR and GRiwrmInputsModel object #' #' @param InputsModel object of class \emph{InputsModel}, see \code{\link[airGR]{CreateInputsModel}} for details. #' @param ... further arguments passed to or from other methods. diff --git a/R/UpdateQsimUpstream.R b/R/UpdateQsimUpstream.R index 63131ac229eb23ca9c98b64d1533d36ed8d61b33..965196a59e4a92ef62f2375d7d83e09a289b5c59 100644 --- a/R/UpdateQsimUpstream.R +++ b/R/UpdateQsimUpstream.R @@ -1,10 +1,10 @@ -#' Update InputsModel$Qupstream with simulated upstream flows provided by GriwrmOutputsModels object. +#' Update InputsModel$Qupstream with simulated upstream flows provided by GRiwrmOutputsModels object. #' -#' @param InputsModel \emph{GriwrmInputsModel} object. See \code{[CreateInputsModel.GRiwrm]}. +#' @param InputsModel \emph{GRiwrmInputsModel} object. See \code{[CreateInputsModel.GRiwrm]}. #' @param IndPeriod_Run numeric index of period to be used for the model run (-) -#' @param OutputsModel \emph{GriwrmOutputsModel} object provided by \code{[RunModel.GriwrmInputsModel]}. +#' @param OutputsModel \emph{GRiwrmOutputsModel} object provided by \code{[RunModel.GRiwrmInputsModel]}. #' -#' @description This function is used by \code{\link{RunModel.GriwrmInputsModel}} and \code{\link{Calibration.GriwrmInputsModel}} in order to provide upstream simulated flows to a node. +#' @description This function is used by \code{\link{RunModel.GRiwrmInputsModel}} and \code{\link{Calibration.GRiwrmInputsModel}} in order to provide upstream simulated flows to a node. #' #' @return InputsModel object with updated QobsUpsr #' diff --git a/vignettes/V01_First_network.Rmd b/vignettes/V01_First_network.Rmd index b52559eabea49fc1e64da8abfbf11f8e4135a8c2..055b18d65715d83f7e719645e557be0de57da491 100644 --- a/vignettes/V01_First_network.Rmd +++ b/vignettes/V01_First_network.Rmd @@ -48,7 +48,7 @@ griwrm The diagram of the network structure is represented below with in blue the upstream nodes with a GR4J model and in green the intermediate nodes with an SD (GR4J + LAG) model. ```{r fig.height = 7, fig.width = 8} -DiagramGriwrm(griwrm) +DiagramGRiwrm(griwrm) ``` diff --git a/vignettes/V03_First_Calibration.Rmd b/vignettes/V03_First_Calibration.Rmd index 4aac02f6227cca1fa267641d1cec3727dc9b14c1..8209db34c85f125871293823d8c0cec8fa17d727 100644 --- a/vignettes/V03_First_Calibration.Rmd +++ b/vignettes/V03_First_Calibration.Rmd @@ -32,7 +32,7 @@ InputsCrit <- CreateInputsCrit( str(InputsCrit) ``` -## GriwrmCalibOptions object +## GRiwrmCalibOptions object ```{r} CalibOptions <- CreateCalibOptions(InputsModel) diff --git a/vignettes/V04_Open-loop_influenced_flow.Rmd b/vignettes/V04_Open-loop_influenced_flow.Rmd index 8479831edd51fa3672b8aff542e97c9c79ec9f78..fb6744e344220c4be5e40e96e5031d20bef913a4 100644 --- a/vignettes/V04_Open-loop_influenced_flow.Rmd +++ b/vignettes/V04_Open-loop_influenced_flow.Rmd @@ -177,7 +177,7 @@ Reservoir connections are added to the GRiwrm object: reservoir_connections$model <- NA reservoir_connections$area <- NA griwrm2 <- rbind(griwrm, reservoir_connections) -DiagramGriwrm(griwrm2) +DiagramGRiwrm(griwrm2) ``` diff --git a/vignettes/V05_Open-loop_influenced_flow_calibration.Rmd b/vignettes/V05_Open-loop_influenced_flow_calibration.Rmd index 22d651a3a9288cec6db8ca21f28524021b0bf239..05a8cc7d8a34444803bc8958186a299bc4280184 100644 --- a/vignettes/V05_Open-loop_influenced_flow_calibration.Rmd +++ b/vignettes/V05_Open-loop_influenced_flow_calibration.Rmd @@ -36,10 +36,10 @@ Remove extra items from global configuration selectedNodes <- c("MARNE_P23", "STDIZ_04", "LOUVE_19", "VITRY_25", "MARNE_P28", "MARNE_R25", "CHALO_21", "MONTR_18", "NOISI_17") griwrm3 <- griwrm2[griwrm2$id %in% selectedNodes,] griwrm3[griwrm3$id == "NOISI_17", c("down", "length")] = NA # Downstream station instead of PARIS_05 -DiagramGriwrm(griwrm3) +DiagramGRiwrm(griwrm3) ``` -Generate `GriwrmInputsModel` object +Generate `GRiwrmInputsModel` object ```{r} Qobs3 <- cbind(Qobs2, QobsReservoirs) @@ -83,7 +83,7 @@ InputsCrit <- CreateInputsCrit( ) ``` -## GriwrmCalibOptions object +## GRiwrmCalibOptions object ```{r} CalibOptions <- CreateCalibOptions(InputsModel3)