docs(man): review text and example of RunModel_Lag help page

Reviewed-by: @guillaume.thirel Refs #99

docs(man): review text and example of RunModel_Lag help page
Reviewed-by: @guillaume.thirel Refs #99
a2e4ccf8 · Delaigue Olivier · 955c8ff9 · a2e4ccf8
Commit a2e4ccf8 authored 4 years ago by Delaigue Olivier
Hide whitespace changes
Inline Side-by-side

Showing

with 5 additions and 5 deletions
+5 -5
--- a/man/RunModel_Lag.Rd
+++ b/man/RunModel_Lag.Rd
@@ -19,7 +19,7 @@ RunModel_Lag(InputsModel, RunOptions, Param)


 \arguments{
-\item{InputsModel}{[object of class \emph{InputsModel}]  created with SD model inputs, see \code{\link{CreateInputsModel}} for details. The object should also contain a key \emph{OutputsModel}] of class \code{\link{CreateInputsModel}} coming from the simulation of the downstream subcatchement runoff.}
+\item{InputsModel}{[object of class \emph{InputsModel}] created with SD model inputs, see \code{\link{CreateInputsModel}} for details. The object should also contain a key \emph{OutputsModel} of class \code{\link{CreateInputsModel}} coming from the simulation of the downstream subcatchment runoff.}

 \item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}

@@ -33,7 +33,7 @@ RunModel_Lag(InputsModel, RunOptions, Param)
 \value{
 [list] see \code{\link{RunModel_GR4J}} or \code{\link{RunModel_CemaNeigeGR4J}} for details.

-The list value contains an extra item named \code{QsimDown} which is a copy of InputsModel\$OutputsModel\$Qsim, a numeric series of simulated discharge [mm/time step] related to the run-off contribution of the downstream sub-catchment.
+The list value contains an extra item named \code{QsimDown} which is a copy of \code{InputsModel$OutputsModel$Qsim}, a numeric series of simulated discharge [mm/time step] related to the runoff contribution of the downstream sub-catchment.
 }


@@ -58,8 +58,8 @@ Qupstream <- Qupstream * 86400
 BasinAreas <- c(NA, BasinInfo$BasinArea)

 ## Delay time between the reservoir and the catchment outlet is 2 days and the distance is 150 km
-LenghtHydro <- 150
-Lag <- LenghtHydro / 2 / 86400 * 1000 # Conversion km/day -> m/s
+LengthHydro <- 150000
+Lag <- LengthHydro / 2 / 86400 * 1000 # Conversion km/day -> m/s

 ## preparation of the InputsModel object
 InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR4J, DatesR = BasinObs$DatesR,
@@ -75,7 +75,7 @@ Ind_Run <- seq(which(format(BasinObs$DatesR, format = "\%Y-\%m-\%d")=="1990-01-0
 RunOptions <- CreateRunOptions(FUN_MOD = RunModel_GR4J,
                               InputsModel = InputsModel, IndPeriod_Run = Ind_Run)

-## simulation of dowstream subcatchment
+## simulation of downstream subcatchment
 Param <- c(X1 = 257.238, X2 = 1.012, X3 = 88.235, X4 = 2.208)
 OutputsModelDown <- RunModel_GR4J(InputsModel = InputsModel,
                                  RunOptions = RunOptions, Param = Param)