docs(man): indent code in 'usage' and 'examples' sections to avoid too long lines in pdf mabual

98245739 · Delaigue Olivier · a31ccdee · 98245739 · 98245739 · 98245739
Commit 98245739 authored 1 year ago by Delaigue Olivier
Hide whitespace changes
Inline Side-by-side

Showing

with 15 additions and 8 deletions
+15 -8
--- a/man/CreateCalibOptions.Rd
+++ b/man/CreateCalibOptions.Rd
@@ -15,7 +15,8 @@ Creation of the \emph{CalibOptions} object required by the \code{Calibration*} f

 \usage{
 CreateCalibOptions(FUN_MOD, FUN_CALIB = Calibration_Michel,
-                   FUN_TRANSFO = NULL, IsHyst = FALSE, IsSD = FALSE, FixedParam = NULL,
+                   FUN_TRANSFO = NULL, IsHyst = FALSE, IsSD = FALSE,
+                   FixedParam = NULL,
                   SearchRanges = NULL, StartParamList = NULL,
                   StartParamDistrib = NULL)
 }

--- a/man/CreateIniStates.Rd
+++ b/man/CreateIniStates.Rd
@@ -14,8 +14,10 @@ Creation of the \emph{IniStates} object possibly required by the \code{\link{Cre


 \usage{
-CreateIniStates(FUN_MOD, InputsModel, IsHyst = FALSE, IsIntStore = FALSE,
-                ProdStore = 350, RoutStore = 90, ExpStore = NULL, IntStore = NULL,
+CreateIniStates(FUN_MOD, InputsModel,
+                IsHyst = FALSE, IsIntStore = FALSE,
+                ProdStore = 350, RoutStore = 90,
+                ExpStore = NULL, IntStore = NULL,
                UH1 = NULL, UH2 = NULL,
                GCemaNeigeLayers = NULL, eTGCemaNeigeLayers = NULL,
                GthrCemaNeigeLayers = NULL, GlocmaxCemaNeigeLayers = NULL,

--- a/man/CreateInputsCrit.Rd
+++ b/man/CreateInputsCrit.Rd
@@ -135,7 +135,8 @@ invisible(ErrorCrit(InputsCrit = InputsCritSingle, OutputsModel = OutputsModel))
 ## 2 efficiency criteria: RMSE and Nash-Sutcliffe Efficiency
 InputsCritMulti <- CreateInputsCrit(FUN_CRIT = list(ErrorCrit_RMSE, ErrorCrit_NSE),
                                    InputsModel = InputsModel, RunOptions = RunOptions,
-                                    Obs = list(BasinObs$Qmm[Ind_Run], BasinObs$Qmm[Ind_Run]),
+                                    Obs = list(BasinObs$Qmm[Ind_Run],
+                                               BasinObs$Qmm[Ind_Run]),
                                    VarObs = list("Q", "Q"), transfo = list("", "sqrt"),
                                    Weights = NULL)
 str(InputsCritMulti)
@@ -145,7 +146,8 @@ invisible(ErrorCrit(InputsCrit = InputsCritMulti, OutputsModel = OutputsModel))
 ##                                 both raw and log-transformed flows
 InputsCritCompo <- CreateInputsCrit(FUN_CRIT = list(ErrorCrit_NSE, ErrorCrit_NSE),
                                    InputsModel = InputsModel, RunOptions = RunOptions,
-                                    Obs = list(BasinObs$Qmm[Ind_Run], BasinObs$Qmm[Ind_Run]),
+                                    Obs = list(BasinObs$Qmm[Ind_Run],
+                                               BasinObs$Qmm[Ind_Run]),
                                    VarObs = list("Q", "Q"), transfo = list("", "log"),
                                    Weights = list(0.4, 0.6))
 str(InputsCritCompo)

--- a/man/ErrorCrit.Rd
+++ b/man/ErrorCrit.Rd
@@ -89,7 +89,8 @@ str(ErrorCrit(InputsCrit = InputsCritSingle, OutputsModel = OutputsModel))
 ## 2 efficiency critera:  RMSE and the Nash-Sutcliffe Efficiency
 InputsCritMulti <- CreateInputsCrit(FUN_CRIT = list(ErrorCrit_RMSE, ErrorCrit_NSE),
                                    InputsModel = InputsModel, RunOptions = RunOptions,
-                                    Obs = list(BasinObs$Qmm[Ind_Run], BasinObs$Qmm[Ind_Run]),
+                                    Obs = list(BasinObs$Qmm[Ind_Run],
+                                               BasinObs$Qmm[Ind_Run]),
                                    VarObs = list("Q", "Q"), transfo = list("", "sqrt"),
                                    Weights = NULL)
 str(ErrorCrit(InputsCrit = InputsCritMulti, OutputsModel = OutputsModel))
@@ -98,7 +99,8 @@ str(ErrorCrit(InputsCrit = InputsCritMulti, OutputsModel = OutputsModel))
 ##                                 both raw and log-transformed flows
 InputsCritCompo <- CreateInputsCrit(FUN_CRIT = list(ErrorCrit_NSE, ErrorCrit_NSE),
                                    InputsModel = InputsModel, RunOptions = RunOptions,
-                                    Obs = list(BasinObs$Qmm[Ind_Run], BasinObs$Qmm[Ind_Run]),
+                                    Obs = list(BasinObs$Qmm[Ind_Run],
+                                               BasinObs$Qmm[Ind_Run]),
                                    VarObs = list("Q", "Q"), transfo = list("", "log"),
                                    Weights = list(0.4, 0.6))
 str(ErrorCrit(InputsCrit = InputsCritCompo, OutputsModel = OutputsModel))

--- a/man/Param_Sets_GR4J.Rd
+++ b/man/Param_Sets_GR4J.Rd
@@ -65,7 +65,7 @@ Ind_Cal <- seq(which(format(BasinObs$DatesR, format = "\%Y-\%m-\%d")=="1990-01-0

 ## preparation of the RunOptions object for the calibration period
 RunOptions_Cal <- CreateRunOptions(FUN_MOD = RunModel_GR4J,
-                               InputsModel = InputsModel, IndPeriod_Run = Ind_Cal)
+                                   InputsModel = InputsModel, IndPeriod_Run = Ind_Cal)

 ## simulation and efficiency criterion (Nash-Sutcliffe Efficiency)
 ## with all generalist parameter sets on the calibration period