Vignette/generaldata (#214)

* doc built cr8 cluster-st

* update doc storage with unit measure for TS

* update vignette with generaldata part

Author: berthetclement

R/createClusterST.R

@@ -16,11 +16,11 @@
 #' generation or consumption on the system `numeric` \{<0;>0\} (8760*1).
 #' @param lower_rule_curve This is the lower limit for filling the stock imposed each hour. `numeric` \{0;1\} (8760*1).
 #' @param upper_rule_curve This is the upper limit for filling the stock imposed each hour. `numeric` \{0;1\} (8760*1).
-#' @param cost_injection Penalizes the injection flowrate at each hour (&euro;/MW) `numeric` \{>0\} (8760*1).
-#' @param cost_withdrawal Penalizes the withdrawal flowrate at each hour (&euro;/MW) `numeric` \{>0\} (8760*1).
-#' @param cost_level Penalizes the volume of stored energy at each hour (&euro;/MW/h) `numeric` \{<0;>0\} (8760*1).
-#' @param cost_variation_injection Penalizes injection flowrate variation every hour (&euro;/MW/h) `numeric` \{>0\} (8760*1).
-#' @param cost_variation_withdrawal Penalizes the withdrawal variation every hour (&euro;/MW/h) `numeric` \{>0\} (8760*1).
+#' @param cost_injection Penalizes the injection flowrate at each hour (&euro;/MWh) `numeric` \{>0\} (8760*1).
+#' @param cost_withdrawal Penalizes the withdrawal flowrate at each hour (&euro;/MWh) `numeric` \{>0\} (8760*1).
+#' @param cost_level Penalizes the volume of stored energy at each hour (&euro;/MWh) `numeric` \{<0;>0\} (8760*1).
+#' @param cost_variation_injection Penalizes injection flowrate variation every hour (&euro;/MWh) `numeric` \{>0\} (8760*1).
+#' @param cost_variation_withdrawal Penalizes the withdrawal variation every hour (&euro;/MWh) `numeric` \{>0\} (8760*1).
 #' @param add_prefix If `TRUE` (the default), `cluster_name` will be prefixed by area name.
 #' @param overwrite `logical`, overwrite the cluster or not.
 #' 

man/createClusterST.Rd

@@ -199,6 +199,28 @@ tab <- readClusterSTDesc()
 rmarkdown::paged_table(tab)
 ```
 
+
+## Generaldata
+
+The “generaldata.ini” settings file (*settings/generaldata.ini*) contains several sections.
+
+Antares Simulator v9.2 deletes some parameters: 
+
+  - *adequacy patch/enable-first-step*
+  - *adequacy patch/set-to-null-ntc-between-physical-out-for-first-step*
+  - *other preferences/initial-reservoir-levels*
+
+A message is displayed and parameters are set to `NULL` for the `[adequacy patch]` section.
+
+For the `[other preferences]` section, the `initial-reservoir-levels` parameter is not explicitly used by a dedicated function.
+
+```{r generaldata}
+# user messages
+updateAdequacySettings(
+    set_to_null_ntc_between_physical_out_for_first_step = FALSE)
+updateAdequacySettings(enable_first_step = FALSE)
+```
+
 ```{r delete study, include=FALSE}
 # Delete study
 unlink(current_study_opts$studyPath,