Correction de la documentation de RunModel_GR2M() #3897

R/RunModel_GR2M.R

@@ -20,29 +20,18 @@
 #_FunctionInputs__________________________________________________________________________________________________
 #' @param  InputsModel         [object of class \emph{InputsModel}] see \code{\link{CreateInputsModel}} for details
 #' @param  RunOptions          [object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details
-#' @param  Param               [numeric] vector of 4 parameters                                                             
+#' @param  Param               [numeric] vector of 2 parameters                                                             
 #'                             \tabular{ll}{                                                                      
 #'                             GR2M X1      \tab production store capacity [mm]                 \cr
-#'                             GR2M X2      \tab groundwater exchange coefficient [mm/month]    \cr
+#'                             GR2M X2      \tab groundwater exchange coefficient [-]    \cr
 #'                             }                                                                                  
 #_FunctionOutputs_________________________________________________________________________________________________
 #' @return  [list] list containing the function outputs organised as follows:                                         
 #'          \tabular{ll}{                                                                                         
 #'          \emph{$DatesR  }          \tab [POSIXlt] series of dates                                                    \cr
-#'          \emph{$PotEvap }          \tab [numeric] series of input potential evapotranspiration [mm/h]                 \cr
-#'          \emph{$Precip  }          \tab [numeric] series of input total precipitation [mm/h]                          \cr
-#'          \emph{$Prod    }          \tab [numeric] series of production store level (X(2)) [mm]                        \cr
-#'          \emph{$AE      }          \tab [numeric] series of actual evapotranspiration [mm/h]                          \cr
-#'          \emph{$Perc    }          \tab [numeric] series of percolation (PERC) [mm/h]                                 \cr
-#'          \emph{$PR      }          \tab [numeric] series of PR=PN-PS+PERC [mm/h]                                      \cr
-#'          \emph{$Q9      }          \tab [numeric] series of HU1 outflow (Q9) [mm/h]                                   \cr
-#'          \emph{$Q1      }          \tab [numeric] series of HU2 outflow (Q1) [mm/h]                                   \cr
-#'          \emph{$Rout    }          \tab [numeric] series of routing store level (X(1)) [mm]                           \cr
-#'          \emph{$Exch    }          \tab [numeric] series of potential semi-exchange between catchments [mm/h]         \cr
-#'          \emph{$AExch   }          \tab [numeric] series of actual exchange between catchments (1+2) [mm/h]           \cr
-#'          \emph{$QR      }          \tab [numeric] series of routing store outflow (QR) [mm/h]                         \cr
-#'          \emph{$QD      }          \tab [numeric] series of direct flow from HU2 after exchange (QD) [mm/h]           \cr
-#'          \emph{$Qsim    }          \tab [numeric] series of Qsim [mm/h]                                               \cr
+#'          \emph{$PotEvap }          \tab [numeric] series of input potential evapotranspiration [mm/month]                 \cr
+#'          \emph{$Precip  }          \tab [numeric] series of input total precipitation [mm/month]                          \cr
+#'          \emph{$Qsim    }          \tab [numeric] series of Qsim [mm/month]                                               \cr
 #'          \emph{$StateEnd}          \tab [numeric] states at the end of the run (res. levels, HU1 levels, HU2 levels) [mm] \cr
 #'          }                                                                                                     
 #'          (refer to the provided references or to the package source code for further details on these model outputs)
@@ -55,7 +44,7 @@ RunModel_GR2M <- function(InputsModel,RunOptions,Param){
 
     ##Arguments_check
       if(inherits(InputsModel,"InputsModel")==FALSE){ stop("InputsModel must be of class 'InputsModel' \n"); return(NULL); }  
-      if(inherits(InputsModel,"monthly"    )==FALSE){ stop("InputsModel must be of class 'monthly'      \n"); return(NULL); }  
+      if(inherits(InputsModel,"monthly"    )==FALSE){ stop("InputsModel must be of class 'monthly'     \n"); return(NULL); }  
       if(inherits(InputsModel,"GR"         )==FALSE){ stop("InputsModel must be of class 'GR'          \n"); return(NULL); }  
       if(inherits(RunOptions,"RunOptions"  )==FALSE){ stop("RunOptions must be of class 'RunOptions'   \n"); return(NULL); }  
       if(inherits(RunOptions,"GR"          )==FALSE){ stop("RunOptions must be of class 'GR'           \n"); return(NULL); }