diff --git a/R/CreateGRiwrm.R b/R/CreateGRiwrm.R
index b2b330b732817fcec2217e2f268072f0c47c4a4f..83cf2672d10e128e72558c0440d090f24ea0db4d 100644
--- a/R/CreateGRiwrm.R
+++ b/R/CreateGRiwrm.R
@@ -7,9 +7,21 @@
#' * the identifier and the hydraulic distance to the downstream node
#' ([character] columns `down` and [numeric] columns `length` in km). The
#' last downstream node should have fields `down` and `length` set to `NA`,
-#' * the area of the basin ([numeric] column `area` in km2)
-#' * the hydrological model to use or [NA] for using observed flow instead of a
-#' runoff model output ([character] column `model`)
+#' * the total area of the basin at the node location ([numeric] column `area` in km2).
+#' Direct injection node can have a null area defined by `NA`
+#' * the model to use ([character] column `model`), see section below for details
+#'
+#' ## Available models in airGRiwrm
+#'
+#' The "model" column should be filled by one of the following:
+#'
+#' * One of the hydrological models available in the *airGR* package defined by its
+#' `RunModel` function (i.e.: `RunModel_GR4J`, `RunModel_GR5HCemaneige`...)
+#' * `NA` for injecting (or abstracting) a flow time series at the location of the node
+#' (direct flow injection)
+#' * `Ungauged` for an ungauged node. The sub-basin inherits hydrological model and
+#' parameters from a "donor" sub-basin. By default the donor is the first gauged
+#' node at downstream
#'
#' @param db [data.frame] description of the network (See details)
#' @param cols [list] or [vector] columns of `db`. By default, mandatory column
@@ -31,6 +43,8 @@
#' node location in km2
#' * `model` ([character]): hydrological model to use ([NA] for using observed
#' flow instead of a runoff model output)
+#' * `donor` ([character]): node used as "donor" for the the model and the
+#' calibration parameters.
#'
#' @aliases GRiwrm
#' @export
diff --git a/man-examples/CreateGRiwrm.R b/man-examples/CreateGRiwrm.R
index f6604cf64688795f96235ff4adcfef9dffff54d4..9ef97c074a3acb9b22aba2e8b03e361548e7b3a4 100644
--- a/man-examples/CreateGRiwrm.R
+++ b/man-examples/CreateGRiwrm.R
@@ -8,7 +8,7 @@ db <- data.frame(id = c("Reservoir", "GaugingDown"),
model = c(NA, "RunModel_GR4J"),
stringsAsFactors = FALSE)
griwrm_basic <- CreateGRiwrm(db)
-str(griwrm_basic)
+griwrm_basic
# Network diagram with direct flow node in red, intermediate sub-basin in green
plot(griwrm_basic)
@@ -22,7 +22,7 @@ rename_columns <- list(id = "gauge_id",
down = "downstream_id",
length = "distance_downstream")
griwrm_severn <- CreateGRiwrm(nodes, rename_columns)
-str(griwrm_severn)
+griwrm_severn
# Network diagram with upstream basin nodes in blue, intermediate sub-basin in green
plot(griwrm_severn)
diff --git a/man/CreateGRiwrm.Rd b/man/CreateGRiwrm.Rd
index f8cad7e94c4baec500071ecacb43f321fe04f09e..24d40194789be032f734d5425a6b9c16cc052407 100644
--- a/man/CreateGRiwrm.Rd
+++ b/man/CreateGRiwrm.Rd
@@ -37,6 +37,8 @@ node (\link{NA} for the most downstream node)
node location in km2
\item \code{model} (\link{character}): hydrological model to use (\link{NA} for using observed
flow instead of a runoff model output)
+\item \code{donor} (\link{character}): node used as "donor" for the the model and the
+calibration parameters.
}
}
\description{
@@ -50,9 +52,22 @@ description of their connections
\item the identifier and the hydraulic distance to the downstream node
(\link{character} columns \code{down} and \link{numeric} columns \code{length} in km). The
last downstream node should have fields \code{down} and \code{length} set to \code{NA},
-\item the area of the basin (\link{numeric} column \code{area} in km2)
-\item the hydrological model to use or \link{NA} for using observed flow instead of a
-runoff model output (\link{character} column \code{model})
+\item the total area of the basin at the node location (\link{numeric} column \code{area} in km2).
+Direct injection node can have a null area defined by \code{NA}
+\item the model to use (\link{character} column \code{model}), see section below for details
+}
+\subsection{Available models in airGRiwrm}{
+
+The "model" column should be filled by one of the following:
+\itemize{
+\item One of the hydrological models available in the \emph{airGR} package defined by its
+\code{RunModel} function (i.e.: \code{RunModel_GR4J}, \code{RunModel_GR5HCemaneige}...)
+\item \code{NA} for injecting (or abstracting) a flow time series at the location of the node
+(direct flow injection)
+\item \code{Ungauged} for an ungauged node. The sub-basin inherits hydrological model and
+parameters from a "donor" sub-basin. By default the donor is the first gauged
+node at downstream
+}
}
}
\examples{
@@ -66,7 +81,7 @@ db <- data.frame(id = c("Reservoir", "GaugingDown"),
model = c(NA, "RunModel_GR4J"),
stringsAsFactors = FALSE)
griwrm_basic <- CreateGRiwrm(db)
-str(griwrm_basic)
+griwrm_basic
# Network diagram with direct flow node in red, intermediate sub-basin in green
plot(griwrm_basic)
@@ -80,7 +95,7 @@ rename_columns <- list(id = "gauge_id",
down = "downstream_id",
length = "distance_downstream")
griwrm_severn <- CreateGRiwrm(nodes, rename_columns)
-str(griwrm_severn)
+griwrm_severn
# Network diagram with upstream basin nodes in blue, intermediate sub-basin in green
plot(griwrm_severn)
diff --git a/man/plot.GRiwrm.Rd b/man/plot.GRiwrm.Rd
index 8d86edbfab337966d1b566769e29f1e07e099491..280c22d5708d8c29b6db9a4ee4244f40b9d8e16b 100644
--- a/man/plot.GRiwrm.Rd
+++ b/man/plot.GRiwrm.Rd
@@ -51,7 +51,7 @@ db <- data.frame(id = c("Reservoir", "GaugingDown"),
model = c(NA, "RunModel_GR4J"),
stringsAsFactors = FALSE)
griwrm_basic <- CreateGRiwrm(db)
-str(griwrm_basic)
+griwrm_basic
# Network diagram with direct flow node in red, intermediate sub-basin in green
plot(griwrm_basic)
@@ -65,7 +65,7 @@ rename_columns <- list(id = "gauge_id",
down = "downstream_id",
length = "distance_downstream")
griwrm_severn <- CreateGRiwrm(nodes, rename_columns)
-str(griwrm_severn)
+griwrm_severn
# Network diagram with upstream basin nodes in blue, intermediate sub-basin in green
plot(griwrm_severn)