Remove depency to readClusterDesc() from antaresRead package (#251)

* Remove depency to `readClusterDesc()` from antaresRead

* Make the control insensitive to case

Author: KKamel67

NEWS.md

@@ -8,6 +8,10 @@ NEW FEATURES :
 * `createDistrict()` uses a specific endpoint to create the district
 * `editDistrict()` allows the user to edit a district. Use of a specific endpoint in API mode.
 
+ENHANCEMENT :
+
+* `createBindingConstraint()`/`editBindingCOnstraint()` : remove depency to `readClusterDesc()` from antaresRead package
+
 BUGFIXES :    
 
 * `.get_version_solver_from_path_solver()` get solver version by running command line instead of searching in the path.

R/createBindingConstraint.R

@@ -42,7 +42,7 @@ utils::globalVariables(c('V2', 'dim_study', 'dim_input', 'name_group'))
 #' 
 #' @name createBindingConstraint
 #' 
-#' @importFrom antaresRead getLinks readClusterDesc setSimulationPath readIniFile simOptions
+#' @importFrom antaresRead getLinks setSimulationPath readIniFile simOptions
 #' @importFrom utils write.table
 #' @importFrom assertthat assert_that
 #'
@@ -212,7 +212,7 @@ createBindingConstraint <- function(name,
     group,
     overwrite,
     links = getLinks(opts = opts, namesOnly = TRUE),
-    clusters = readClusterDesc(opts = opts),
+    clusters = .list_clusters_for_binding_constraints(opts = opts),
     output_operator = values_operator,
     opts = opts
   )
@@ -668,7 +668,7 @@ group_values_meta_check <- function(group_value,
 #' @template opts
 #' @family binding constraints functions
 #'
-#' @importFrom antaresRead getLinks setSimulationPath readIniFile readClusterDesc
+#' @importFrom antaresRead getLinks setSimulationPath readIniFile
 #' 
 #' @details 
 #' According to Antares version, usage may vary :
@@ -754,7 +754,7 @@ createBindingConstraintBulk <- function(constraints,
   bindingConstraints <- readIniFile(pathIni, stringsAsFactors = FALSE)
 
   all_links <- getLinks(opts = opts, namesOnly = TRUE)
-  all_clusters <- readClusterDesc(opts = opts)
+  all_clusters <- .list_clusters_for_binding_constraints(opts = opts)
 
   for (i in seq_along(constraints)) {
     values_operator <- switch_to_list_name_operator_870(operator = constraints[[i]][["operator"]])
@@ -893,12 +893,43 @@ switch_to_list_name_operator_870 <- function(operator) {
   }
 
   coefficientsToControl <- coefficients[grep(type_elements[[type]][["pattern"]], names(coefficients))]
+  coefs_names <- tolower(names(coefficientsToControl))
 
-  if(length(coefficientsToControl) > 0) {
-    if (!all(names(coefficientsToControl) %in% reference)) {
-      badcoef <- names(coefficientsToControl)[!names(coefficientsToControl) %in% reference]
+  if(length(coefs_names) > 0) {
+    if (!all(coefs_names %in% reference)) {
+      badcoef <- coefs_names[!coefs_names %in% reference]
       badcoef <- paste(shQuote(badcoef), collapse = ", ")
       stop(paste0(badcoef, " : is or are not valid ", type_elements[[type]][["stop_msg"]]))
     }
   }
 }
+
+
+#' @importFrom antaresRead readIniFile
+.list_clusters_for_binding_constraints <- function(opts) {
+  
+  path <- file.path(opts[["inputPath"]], "thermal", "clusters")
+  areas <- data.frame("area" = list.files(path))
+  areas$path <- file.path(path, areas$area, "list.ini")
+  areas$file_size <- sapply(areas$path, file.size)
+  areas_fi <- areas[areas$file_size > 0,]
+  
+  all_clusters <- data.frame("area" = c(), "cluster" = c())
+  if (nrow(areas_fi) > 0) {
+    clusters_by_area <- apply(areas_fi[,c("area","path")],
+                              MARGIN = 1,
+                              FUN = function(row) {
+                                iniFile <- readIniFile(file = as.character(row[2]))
+                                cl_names <- sapply(X = iniFile, "[[", "name")
+                                cl_names <- unname(cl_names)
+                                df_cl_names <- data.frame("area" = rep(as.character(row[1]), length(cl_names)), "cluster" = cl_names)
+                                return(df_cl_names)
+                              }
+    )
+    all_clusters <- do.call("rbind", clusters_by_area)
+    all_clusters$area <- tolower(all_clusters$area)
+    all_clusters$cluster <- tolower(all_clusters$cluster)
+  }
+  
+  return(all_clusters)
+}

R/editBindingConstraint.R

@@ -28,7 +28,7 @@
 #' 
 #' @export
 #' 
-#' @importFrom antaresRead getLinks setSimulationPath readClusterDesc simOptions readIniFile
+#' @importFrom antaresRead getLinks setSimulationPath simOptions readIniFile
 #' @importFrom utils write.table
 #' @importFrom assertthat assert_that
 #' @importFrom data.table as.data.table fwrite
@@ -205,7 +205,7 @@ editBindingConstraint <- function(name,
     }
 
     if (has_clusters_coefs) {
-      clusters <- readClusterDesc(opts = opts)
+      clusters <- .list_clusters_for_binding_constraints(opts = opts)
       .check_bc_validity_coefficients(coefficients = coefficients, reference = clusters, type = "thermal")
     }
 

tests/testthat/test-createBindingConstraint.R

@@ -20,6 +20,17 @@ sapply(studies, function(study) {
     )
 
     expect_true("myconstraint" %in% names(antaresRead::readBindingConstraints()))
+    
+    createBindingConstraint(
+      name = "myconstraint_coef_no_lower", 
+      values = matrix(data = rep(0, 8760 * 3), ncol = 3), 
+      enabled = FALSE,
+      coefficients =  c("a.BaSe" = 0.1, "c.PeaK" = 0.3),      
+      timeStep = "hourly",
+      operator = "both"
+    )
+    
+    expect_true("myconstraint_coef_no_lower" %in% names(antaresRead::readBindingConstraints()))
   })