update setSimulationPath()/setSimulationPath() with new parameter 've…

…rbose' + doc + test + newsmd (#274)

NEWS.md

@@ -2,7 +2,11 @@
 
 
 # antaresRead 2.8.0.9000 
-(cf. Antares v9 changelog)
+(cf. Antares v9 changelog)  
+
+NEW FEATURES:  
+
+* `setSimulationPath()` / `setSimulationPathAPI()` have a new parameter `'verbose'` (default to `FALSE`) to manage diagnostic messages
 
 BUGFIXES :  
 

R/setSimulationPath.R

@@ -73,6 +73,7 @@
 #'   \item{firstWeekday}{First day of the week.}
 #'   \item{districtsDef}{data.table containing the specification of the districts.}
 #'   \item{energyCosts}{list containing the cost of spilled and unsupplied energy.}
+#'   \item{verbose}{`logical` default to FALSE, put to TRUE to manage diagnostic messages}
 #' 
 #' @seealso 
 #'   \code{\link{simOptions}}, \code{\link{readAntares}}, \code{\link{readLayout}}, 
@@ -221,6 +222,7 @@ setSimulationPath <- function(path, simulation = NULL) {
   res$districtsDef <- .readDistrictsDef(res$inputPath, res$areaList)
   res$energyCosts <- .readEnergyCosts(res$inputPath)
   res$typeLoad <- "txt"
+  res$verbose <- FALSE
   class(res) <- c("simOptions")
 
   options(antares=res)

R/setSimulationPathAPI.R

@@ -390,6 +390,9 @@ setSimulationPathAPI <- function(host, study_id, token, simulation = NULL,
 
   # timer for api commande execute
   res$sleep <- 0.5
+
+  # param "verbose" similar to disk mode
+  res$verbose <- FALSE
 
   class(res) <- c("simOptions")
 

tests/testthat/test-setSimulationPath.R

@@ -34,7 +34,8 @@ trueOpts <- list(
                "b - psp in", "b - psp out", "c - hub", "hub - psp in-2", 
                "hub - psp out-2"),
   areasWithClusters = c("a", "b", "c", "psp in", "psp in-2", "psp out", "psp out-2"),
-  districtsDef = data.table(district = as.factor("a and b"), area = as.factor(c("a", "b")))
+  districtsDef = data.table(district = as.factor("a and b"), area = as.factor(c("a", "b"))),
+  verbose = FALSE
 )
 
 test_that("setSimulationPath reads correct values", {