From 7c0611780a72c6bf2065185fbad07b7a368f6a9e Mon Sep 17 00:00:00 2001 From: berthetclement Date: Tue, 30 Apr 2024 09:24:15 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20rte-anta?= =?UTF-8?q?res-rpackage/antaresEditObject@f13f052451fbd53377077befa69462ba?= =?UTF-8?q?dfbd2462=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.html | 2 +- LICENSE-text.html | 2 +- articles/Antares_new_features_v860.html | 27 ++-- articles/antaresEditObject.html | 16 +-- articles/api-variant-management.html | 17 +-- articles/index.html | 2 +- articles/renewables-energy-sources.html | 4 +- articles/scenario-builder.html | 38 ++++-- authors.html | 6 +- index.html | 2 +- news/index.html | 50 +++++-- pkgdown.yml | 2 +- reference/activateRES.html | 8 +- reference/activateST.html | 8 +- reference/add_week_number_column_to_ts.html | 2 +- reference/adequacyOptions.html | 2 +- reference/antaresRead-reexports.html | 4 +- reference/backupStudy.html | 6 +- reference/check-version.html | 8 +- reference/checkRemovedArea.html | 6 +- .../check_consistency_reservoir_values.html | 2 +- reference/check_mingen_vs_hydro_storage.html | 6 +- reference/check_mingen_vs_maxpower.html | 6 +- reference/cleanUpOutput.html | 4 +- reference/computeOtherFromHourlyMulti.html | 6 +- reference/computeOtherFromHourlyYear.html | 4 +- reference/computeTimeStampFromHourly.html | 4 +- reference/convertConfigToAdq.html | 4 +- reference/copyOutput.html | 6 +- reference/copyStudyWeb.html | 6 +- reference/create-binding-constraint.html | 8 +- reference/create-study.html | 4 +- reference/createArea.html | 8 +- reference/createCluster.html | 12 +- reference/createClusterBulk.html | 8 +- reference/createClusterST.html | 10 +- reference/createDSR.html | 14 +- reference/createDistrict.html | 6 +- reference/createLink.html | 8 +- reference/createPSP.html | 14 +- .../create_scb_referential_series_type.html | 111 ++++++++++++++++ reference/deleteStudy.html | 4 +- .../detect_pattern_in_binding_constraint.html | 125 ++++++++++++++++++ reference/dicoGeneralSettings.html | 2 +- reference/dicoOptimizationSettings.html | 2 +- reference/dot-dailyToWeekly.html | 4 +- reference/dot-hourlyToOther.html | 2 +- reference/editArea.html | 14 +- reference/editBindingConstraint.html | 6 +- reference/editCluster.html | 8 +- reference/editClusterST.html | 6 +- reference/editLink.html | 6 +- reference/fill_empty_hydro_ini_file.html | 6 +- reference/fill_empty_hydro_ts_file.html | 6 +- reference/filteringOptions.html | 2 +- reference/getJobLogs.html | 8 +- reference/getJobs.html | 6 +- reference/get_default_hydro_ini_values.html | 2 +- ...get_type_check_mingen_vs_hydrostorage.html | 2 +- ...eck_mingen_vs_hydrostorage_to_trigger.html | 6 +- ...e_check_mingen_vs_maxpower_to_trigger.html | 6 +- reference/importZipStudyWeb.html | 6 +- reference/index.html | 8 +- reference/list_pollutants_values.html | 2 +- reference/mockSimulationAPI.html | 4 +- reference/nodalOptimizationOptions.html | 2 +- reference/playlist.html | 12 +- reference/propertiesLinkOptions.html | 2 +- reference/removeArea.html | 6 +- reference/removeBindingConstraint.html | 6 +- reference/removeCluster.html | 10 +- reference/removeLink.html | 6 +- reference/replicate_missing_ts.html | 2 +- reference/rollback_to_previous_data.html | 6 +- reference/runSimulation.html | 6 +- reference/runTsGenerator.html | 8 +- reference/scenario-builder.html | 40 ++++-- reference/searchStudy.html | 2 +- reference/setAPImode.html | 6 +- reference/setSolverPath.html | 2 +- reference/storage_values_default.html | 2 +- reference/updateAdequacySettings.html | 6 +- reference/updateGeneralSettings.html | 6 +- reference/updateInputSettings.html | 6 +- reference/updateOptimizationSettings.html | 6 +- reference/updateOutputSettings.html | 6 +- reference/variant-commands.html | 8 +- reference/variant.html | 8 +- reference/write-ini.html | 6 +- reference/writeEconomicOptions.html | 8 +- reference/writeHydroValues.html | 6 +- reference/writeIniHydro.html | 8 +- reference/writeInputTS.html | 6 +- reference/writeMiscGen.html | 6 +- reference/writeOutputValues.html | 8 +- reference/writeSeriesPrepro.html | 6 +- reference/writeWaterValues.html | 6 +- sitemap.xml | 5 +- 98 files changed, 617 insertions(+), 318 deletions(-) create mode 100644 reference/create_scb_referential_series_type.html create mode 100644 reference/detect_pattern_in_binding_constraint.html diff --git a/404.html b/404.html index c67e7e1e..a45c3c9a 100644 --- a/404.html +++ b/404.html @@ -32,7 +32,7 @@ antaresEditObject - 0.6.2 + 0.6.3 diff --git a/LICENSE-text.html b/LICENSE-text.html index 928c93f3..f662d66c 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3 diff --git a/articles/Antares_new_features_v860.html b/articles/Antares_new_features_v860.html index 89cfec4a..8f4c39f7 100644 --- a/articles/Antares_new_features_v860.html +++ b/articles/Antares_new_features_v860.html @@ -33,7 +33,7 @@ antaresEditObject - 0.6.2 + 0.6.3 @@ -164,6 +164,7 @@

Create “st-storage”= ratio_values, upper_rule_curve = ratio_values, overwrite = TRUE) +#> Warning: No cluster description available. #> x being coerced from class: matrix to data.table #> x being coerced from class: matrix to data.table #> x being coerced from class: matrix to data.table @@ -186,7 +187,7 @@

Create “st-storage”#> x being coerced from class: matrix to data.table

Now you can see informations in simulation options.

-opts <- simOptions()
+opts <- simOptions()
 opts$areasWithSTClusters
 #> [1] "fr" "it"
@@ -194,9 +195,9 @@

Create “st-storage”Read st-storages parameters

After creating “st-storage” clusters, you can read all information -with specific function readClusterSTDesc().

+with specific function readClusterSTDesc().

-tab <- readClusterSTDesc()
+tab <- readClusterSTDesc()
 rmarkdown::paged_table(tab)
+ + +
+
+ + + +
+
+
+

Create the correspondence data frame between the symbol and the type in scenario builder

+ Source: R/scenarioBuilder.R + +
+ +
+

Create the correspondence data frame between the symbol and the type in scenario builder

+
+ +
+ 
create_scb_referential_series_type()
+
+ +
+

Value

+ + +

a data.frame.

+
+ +
+ +
+ + +
+

Developed by Tatiana Vargas, Frederic Breant, Victor Perrier.

+
+ +
+

Site built with pkgdown 2.0.9.

+
+ +
+ + + + + + + + diff --git a/reference/deleteStudy.html b/reference/deleteStudy.html index 62ce00bf..515b70d1 100644 --- a/reference/deleteStudy.html +++ b/reference/deleteStudy.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -75,7 +75,7 @@

Delete a study or a simulation

- 
deleteStudy(opts = simOptions(), prompt_validation = FALSE, simulation = NULL)
+ 
deleteStudy(opts = simOptions(), prompt_validation = FALSE, simulation = NULL)
diff --git a/reference/detect_pattern_in_binding_constraint.html b/reference/detect_pattern_in_binding_constraint.html new file mode 100644 index 00000000..00a3c719 --- /dev/null +++ b/reference/detect_pattern_in_binding_constraint.html @@ -0,0 +1,125 @@ + +Detect a pattern in a binding constraint coefficient — detect_pattern_in_binding_constraint • antaresEditObject + + +
+
+ + + +
+
+
+

Detect a pattern in a binding constraint coefficient

+ Source: R/utils.R + +
+ +
+

Detect a pattern in a binding constraint coefficient

+
+ +
+ 
detect_pattern_in_binding_constraint(pattern, opts = antaresRead::simOptions())
+
+ +
+

Arguments

+
pattern
+

The pattern to detect.

+ + +
opts
+

List of simulation parameters returned by the function +antaresRead::setSimulationPath()

+ +
+
+

Value

+ + +

An updated list containing various information about the simulation.

+ + +

the names of the binding constraints containing the pattern

+
+ +
+ +
+ + +
+

Developed by Tatiana Vargas, Frederic Breant, Victor Perrier.

+
+ +
+

Site built with pkgdown 2.0.9.

+
+ +
+ + + + + + + + diff --git a/reference/dicoGeneralSettings.html b/reference/dicoGeneralSettings.html index 1eb77d05..4c46715d 100644 --- a/reference/dicoGeneralSettings.html +++ b/reference/dicoGeneralSettings.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3
diff --git a/reference/dicoOptimizationSettings.html b/reference/dicoOptimizationSettings.html index f5e4483a..2a6cea3a 100644 --- a/reference/dicoOptimizationSettings.html +++ b/reference/dicoOptimizationSettings.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3 diff --git a/reference/dot-dailyToWeekly.html b/reference/dot-dailyToWeekly.html index e7bdc319..ce879f40 100644 --- a/reference/dot-dailyToWeekly.html +++ b/reference/dot-dailyToWeekly.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3 @@ -75,7 +75,7 @@

Computation function for rebuild mc-ind weekly from daily data.

- 
.dailyToWeekly(dailydata, opts = simOptions(), type)
+ 
.dailyToWeekly(dailydata, opts = simOptions(), type)
diff --git a/reference/dot-hourlyToOther.html b/reference/dot-hourlyToOther.html index 566c28c4..0e904411 100644 --- a/reference/dot-hourlyToOther.html +++ b/reference/dot-hourlyToOther.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3
diff --git a/reference/editArea.html b/reference/editArea.html index 51e0c6d2..552fa719 100644 --- a/reference/editArea.html +++ b/reference/editArea.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3 @@ -84,7 +84,7 @@

Edit an area in an Antares study

nodalOptimization = NULL, filtering = NULL, adequacy = NULL, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) @@ -116,7 +116,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

@@ -137,18 +137,18 @@

Examples

library(antaresRead) # Set simulation path -setSimulationPath(path = "PATH/TO/SIMULATION", simulation = "input") +setSimulationPath(path = "PATH/TO/SIMULATION", simulation = "input") # Edit an existing area editArea("area", color = grDevices::rgb(230, 108, 44, max = 255), localization = c(1, 1), - opts = antaresRead::simOptions()) + opts = antaresRead::simOptions()) editArea("de", nodalOptimization = list("spilledenergycost" = list(fr = 30)), -opts = antaresRead::simOptions()) +opts = antaresRead::simOptions()) editArea("de", nodalOptimization = nodalOptimizationOptions(), -opts = antaresRead::simOptions()) +opts = antaresRead::simOptions()) editArea( "de", diff --git a/reference/editBindingConstraint.html b/reference/editBindingConstraint.html index 8a147392..2726d80e 100644 --- a/reference/editBindingConstraint.html +++ b/reference/editBindingConstraint.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -87,7 +87,7 @@

Update an existing binding constraint

filter_year_by_year = NULL, filter_synthesis = NULL, coefficients = NULL, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) @@ -132,7 +132,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/editCluster.html b/reference/editCluster.html index fb85cf46..4012c5e4 100644 --- a/reference/editCluster.html +++ b/reference/editCluster.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -86,7 +86,7 @@

Edit an existing cluster

prepro_data = NULL, prepro_modulation = NULL, add_prefix = TRUE, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) editClusterRES( @@ -95,7 +95,7 @@

Edit an existing cluster

..., time_series = NULL, add_prefix = TRUE, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) @@ -139,7 +139,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/editClusterST.html b/reference/editClusterST.html index ccb5f84b..aeee23ee 100644 --- a/reference/editClusterST.html +++ b/reference/editClusterST.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -88,7 +88,7 @@

Edit a short-term storage cluster

lower_rule_curve = NULL, upper_rule_curve = NULL, add_prefix = TRUE, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) @@ -136,7 +136,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/editLink.html b/reference/editLink.html index 20ef56b0..11fa6417 100644 --- a/reference/editLink.html +++ b/reference/editLink.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -88,7 +88,7 @@

Edit a link between two areas

filter_year_by_year = NULL, dataLink = NULL, tsLink = NULL, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) @@ -137,7 +137,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/fill_empty_hydro_ini_file.html b/reference/fill_empty_hydro_ini_file.html index aed3baa6..fbc3b28e 100644 --- a/reference/fill_empty_hydro_ini_file.html +++ b/reference/fill_empty_hydro_ini_file.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -75,7 +75,7 @@

Write default values in hydro.ini file if the section is empty

- 
fill_empty_hydro_ini_file(area, opts = antaresRead::simOptions())
+ 
fill_empty_hydro_ini_file(area, opts = antaresRead::simOptions())
@@ -86,7 +86,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath().

+antaresRead::setSimulationPath().

diff --git a/reference/fill_empty_hydro_ts_file.html b/reference/fill_empty_hydro_ts_file.html index 9a1fa9fc..b99729a7 100644 --- a/reference/fill_empty_hydro_ts_file.html +++ b/reference/fill_empty_hydro_ts_file.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3 @@ -75,7 +75,7 @@

Write default input time series if mingen.txt or/and mod.
- 
fill_empty_hydro_ts_file(area, opts = antaresRead::simOptions())
+ 
fill_empty_hydro_ts_file(area, opts = antaresRead::simOptions())
@@ -86,7 +86,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath().

+antaresRead::setSimulationPath().

diff --git a/reference/filteringOptions.html b/reference/filteringOptions.html index 96417bab..f03cd726 100644 --- a/reference/filteringOptions.html +++ b/reference/filteringOptions.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3 diff --git a/reference/getJobLogs.html b/reference/getJobLogs.html index c1163100..b567611d 100644 --- a/reference/getJobLogs.html +++ b/reference/getJobLogs.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3 @@ -75,7 +75,7 @@

Retrieve job log from API

- 
getJobLogs(job_id, opts = antaresRead::simOptions())
+ 
getJobLogs(job_id, opts = antaresRead::simOptions())
@@ -86,7 +86,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

@@ -100,7 +100,7 @@

Value

Examples

if (FALSE) {
 
-antaresRead::setSimulationPathAPI(
+antaresRead::setSimulationPathAPI(
   host = "http://localhost:8080",
   study_id = "39c604fc-687f-46c4-9fa6-59b57ff9c8d1",
   token = NULL,
diff --git a/reference/getJobs.html b/reference/getJobs.html
index 44d1c561..d773d8b4 100644
--- a/reference/getJobs.html
+++ b/reference/getJobs.html
@@ -17,7 +17,7 @@
       
       
         antaresEditObject
-        0.6.2
+        0.6.3
@@ -75,7 +75,7 @@

Retrieve API jobs

- 
getJobs(job_id = NULL, opts = antaresRead::simOptions())
+ 
getJobs(job_id = NULL, opts = antaresRead::simOptions())
@@ -86,7 +86,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/get_default_hydro_ini_values.html b/reference/get_default_hydro_ini_values.html index de9a0b5c..866a3134 100644 --- a/reference/get_default_hydro_ini_values.html +++ b/reference/get_default_hydro_ini_values.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3
diff --git a/reference/get_type_check_mingen_vs_hydrostorage.html b/reference/get_type_check_mingen_vs_hydrostorage.html index b90db53c..57303cde 100644 --- a/reference/get_type_check_mingen_vs_hydrostorage.html +++ b/reference/get_type_check_mingen_vs_hydrostorage.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3 diff --git a/reference/get_type_check_mingen_vs_hydrostorage_to_trigger.html b/reference/get_type_check_mingen_vs_hydrostorage_to_trigger.html index 8c19f437..993e865c 100644 --- a/reference/get_type_check_mingen_vs_hydrostorage_to_trigger.html +++ b/reference/get_type_check_mingen_vs_hydrostorage_to_trigger.html @@ -20,7 +20,7 @@ antaresEditObject - 0.6.2 + 0.6.3 @@ -82,7 +82,7 @@

Get the type of control to execute between mingen data and hydro storage dat 
get_type_check_mingen_vs_hydrostorage_to_trigger(
   area,
-  opts = antaresRead::simOptions()
+  opts = antaresRead::simOptions()
 )
@@ -94,7 +94,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath().

+antaresRead::setSimulationPath().

diff --git a/reference/get_type_check_mingen_vs_maxpower_to_trigger.html b/reference/get_type_check_mingen_vs_maxpower_to_trigger.html index 6b70bbef..d59df68a 100644 --- a/reference/get_type_check_mingen_vs_maxpower_to_trigger.html +++ b/reference/get_type_check_mingen_vs_maxpower_to_trigger.html @@ -21,7 +21,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -84,7 +84,7 @@

Get the type of control to execute between mingen data and maxpower data

get_type_check_mingen_vs_maxpower_to_trigger(
   area,
-  opts = antaresRead::simOptions()
+  opts = antaresRead::simOptions()
 )
@@ -96,7 +96,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath().

+antaresRead::setSimulationPath().

diff --git a/reference/importZipStudyWeb.html b/reference/importZipStudyWeb.html index 3f7cb1f0..9e37145e 100644 --- a/reference/importZipStudyWeb.html +++ b/reference/importZipStudyWeb.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -75,7 +75,7 @@

Import a local study to Antares Web

- 
importZipStudyWeb(host, token, zipfile_name, opts = antaresRead::simOptions())
+ 
importZipStudyWeb(host, token, zipfile_name, opts = antaresRead::simOptions())
@@ -94,7 +94,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/index.html b/reference/index.html index 1f388106..e242a0a6 100644 --- a/reference/index.html +++ b/reference/index.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -181,13 +181,17 @@

All functions

Create a Pumped Storage Power plant (PSP)

-

create_referential_series_type()

+

create_scb_referential_series_type()

Create the correspondence data frame between the symbol and the type in scenario builder

deleteStudy()

Delete a study or a simulation

+ +

detect_pattern_in_binding_constraint()

+ +

Detect a pattern in a binding constraint coefficient

dicoGeneralSettings()

diff --git a/reference/list_pollutants_values.html b/reference/list_pollutants_values.html index ec343186..360cb1af 100644 --- a/reference/list_pollutants_values.html +++ b/reference/list_pollutants_values.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3 diff --git a/reference/mockSimulationAPI.html b/reference/mockSimulationAPI.html index da63b63f..0abfffbf 100644 --- a/reference/mockSimulationAPI.html +++ b/reference/mockSimulationAPI.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3 @@ -84,7 +84,7 @@

Mock API usage

Arguments

force

Logical, force mocking simulation even if -antaresRead::setSimulationPathAPI has already been called.

+antaresRead::setSimulationPathAPI has already been called.

antares_version
diff --git a/reference/nodalOptimizationOptions.html b/reference/nodalOptimizationOptions.html index ef682d44..8fc93859 100644 --- a/reference/nodalOptimizationOptions.html +++ b/reference/nodalOptimizationOptions.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3 diff --git a/reference/playlist.html b/reference/playlist.html index 995bec5c..2b74cb6e 100644 --- a/reference/playlist.html +++ b/reference/playlist.html @@ -21,7 +21,7 @@ antaresEditObject - 0.6.2 + 0.6.3 @@ -83,16 +83,16 @@

Get the playlist of an Antares study
- 
getPlaylist(opts = antaresRead::simOptions())
+    
getPlaylist(opts = antaresRead::simOptions())
 
-setPlaylist(playlist, weights = NULL, opts = antaresRead::simOptions())

+setPlaylist(playlist, weights = NULL, opts = antaresRead::simOptions())

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

playlist
@@ -114,9 +114,9 @@

Value

Examples

if (FALSE) {
-setSimulationPath("PATH/TO/STUDY/")
+setSimulationPath("PATH/TO/STUDY/")
 # or 
-setSimulationPathAPI(
+setSimulationPathAPI(
   host = "http://localhost:8080",
   study_id = "6f98a393-155d-450f-a581-8668dc355235",
   token = NULL,
diff --git a/reference/propertiesLinkOptions.html b/reference/propertiesLinkOptions.html
index 5ac38a2f..92b1a662 100644
--- a/reference/propertiesLinkOptions.html
+++ b/reference/propertiesLinkOptions.html
@@ -17,7 +17,7 @@
       
       
         antaresEditObject
-        0.6.2
+        0.6.3
diff --git a/reference/removeArea.html b/reference/removeArea.html index 9a96a863..d27add31 100644 --- a/reference/removeArea.html +++ b/reference/removeArea.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -77,7 +77,7 @@

Remove an area from an Antares study

- 
removeArea(name, opts = antaresRead::simOptions())
+ 
removeArea(name, opts = antaresRead::simOptions())
@@ -88,7 +88,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/removeBindingConstraint.html b/reference/removeBindingConstraint.html index 8409fb7b..4dfe07f9 100644 --- a/reference/removeBindingConstraint.html +++ b/reference/removeBindingConstraint.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -77,7 +77,7 @@

Remove a Binding Constraint

- 
removeBindingConstraint(name, opts = antaresRead::simOptions())
+ 
removeBindingConstraint(name, opts = antaresRead::simOptions())
@@ -88,7 +88,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/removeCluster.html b/reference/removeCluster.html index 2cfa82de..0619f913 100644 --- a/reference/removeCluster.html +++ b/reference/removeCluster.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -81,21 +81,21 @@

Remove a cluster

area, cluster_name, add_prefix = TRUE, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) removeClusterRES( area, cluster_name, add_prefix = TRUE, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) removeClusterST( area, cluster_name, add_prefix = TRUE, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) @@ -115,7 +115,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/removeLink.html b/reference/removeLink.html index 3943ec64..a7701d52 100644 --- a/reference/removeLink.html +++ b/reference/removeLink.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -77,7 +77,7 @@

Remove a link between two areas

- 
removeLink(from, to, opts = antaresRead::simOptions())
+ 
removeLink(from, to, opts = antaresRead::simOptions())
@@ -88,7 +88,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/replicate_missing_ts.html b/reference/replicate_missing_ts.html index c64606da..d2022ff1 100644 --- a/reference/replicate_missing_ts.html +++ b/reference/replicate_missing_ts.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3
diff --git a/reference/rollback_to_previous_data.html b/reference/rollback_to_previous_data.html index 2cebf53d..837b872f 100644 --- a/reference/rollback_to_previous_data.html +++ b/reference/rollback_to_previous_data.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3 @@ -81,7 +81,7 @@

Rollback to previous hydro data if the data is not consistent

area, prev_data, rollback_type, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) @@ -101,7 +101,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath().

+antaresRead::setSimulationPath().

diff --git a/reference/runSimulation.html b/reference/runSimulation.html index d7503732..eff68759 100644 --- a/reference/runSimulation.html +++ b/reference/runSimulation.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -85,7 +85,7 @@

Run an Antares Simulation

show_output_on_console = FALSE, parallel = TRUE, ..., - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) @@ -126,7 +126,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/runTsGenerator.html b/reference/runTsGenerator.html index 310f1056..85182242 100644 --- a/reference/runTsGenerator.html +++ b/reference/runTsGenerator.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -79,7 +79,7 @@

Run Time-Series Generator

path_solver = getOption("antares.solver"), wait = TRUE, show_output_on_console = FALSE, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) @@ -101,7 +101,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath.

+antaresRead::setSimulationPath.

@@ -109,7 +109,7 @@

Arguments

Examples

if (FALSE) {
 library(antaresRead)
-setSimulationPath(path = "path/to/study")
+setSimulationPath(path = "path/to/study")
 
 library(antaresEditObject)
 runTsGenerator(
diff --git a/reference/scenario-builder.html b/reference/scenario-builder.html
index 5f7d0ad8..09fe8cfb 100644
--- a/reference/scenario-builder.html
+++ b/reference/scenario-builder.html
@@ -18,7 +18,7 @@
       
       
         antaresEditObject
-        0.6.2
+        0.6.3
@@ -83,13 +83,13 @@

Read, create, update & deduplicate scenario builder

areas = NULL, areas_rand = NULL, coef_hydro_levels = NULL, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) readScenarioBuilder( ruleset = "Default Ruleset", as_matrix = TRUE, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) updateScenarioBuilder( @@ -98,17 +98,17 @@

Read, create, update & deduplicate scenario builder

series = NULL, clusters_areas = NULL, links = NULL, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) clearScenarioBuilder( ruleset = "Default Ruleset", - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) deduplicateScenarioBuilder( ruleset = "Default Ruleset", - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) @@ -136,7 +136,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

ruleset
@@ -181,8 +181,22 @@

Value

Note

-

series = "ntc" is only available with Antares >= 8.2.0. -series = "hl" each value must be between 0 and 1.

+ +

For a single matrix, value of series can be :

+
+

See also

+

Scenario Builder vignette

@@ -193,7 +207,7 @@

Examples

library(antaresEditObject) # simulation path -setSimulationPath( +setSimulationPath( path = "pat/to/simulation", simulation = "input" ) @@ -230,8 +244,8 @@

Examples

# Update scenario builder -# for load serie -updateScenarioBuilder(ldata = sbuilder, series = "load") +# Single matrix for load serie +updateScenarioBuilder(ldata = sbuilder, series = "load") # can be l instead of load # equivalent as updateScenarioBuilder(ldata = list(l = sbuilder)) @@ -246,7 +260,7 @@

Examples

series = c("load", "hydro", "solar") ) -# different input +# List of matrix updateScenarioBuilder(ldata = list( l = load_sb, h = hydro_sb, diff --git a/reference/searchStudy.html b/reference/searchStudy.html index 434c9906..287348f6 100644 --- a/reference/searchStudy.html +++ b/reference/searchStudy.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3
diff --git a/reference/setAPImode.html b/reference/setAPImode.html index e4a0e8a1..775cdd82 100644 --- a/reference/setAPImode.html +++ b/reference/setAPImode.html @@ -21,7 +21,7 @@ antaresEditObject - 0.6.2 + 0.6.3 @@ -80,7 +80,7 @@

Set API mode

- 
setAPImode(mode = c("sync", "async"), opts = antaresRead::simOptions())
+ 
setAPImode(mode = c("sync", "async"), opts = antaresRead::simOptions())
@@ -91,7 +91,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/setSolverPath.html b/reference/setSolverPath.html index 434eca47..565d1b47 100644 --- a/reference/setSolverPath.html +++ b/reference/setSolverPath.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3
diff --git a/reference/storage_values_default.html b/reference/storage_values_default.html index 90f0bb94..9dbf2762 100644 --- a/reference/storage_values_default.html +++ b/reference/storage_values_default.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3 diff --git a/reference/updateAdequacySettings.html b/reference/updateAdequacySettings.html index 89f83694..42649fa5 100644 --- a/reference/updateAdequacySettings.html +++ b/reference/updateAdequacySettings.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3 @@ -88,7 +88,7 @@

Update adequacy parameters of an Antares study

threshold_initiate_curtailment_sharing_rule = NULL, threshold_display_local_matching_rule_violations = NULL, threshold_csr_variable_bounds_relaxation = NULL, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) @@ -136,7 +136,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/updateGeneralSettings.html b/reference/updateGeneralSettings.html index 507160bc..7fdf9251 100644 --- a/reference/updateGeneralSettings.html +++ b/reference/updateGeneralSettings.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -109,7 +109,7 @@

Update general parameters of an Antares study

refreshintervalsolar = NULL, readonly = NULL, geographic.trimming = NULL, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) @@ -244,7 +244,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/updateInputSettings.html b/reference/updateInputSettings.html index 48d872ee..9814fe7f 100644 --- a/reference/updateInputSettings.html +++ b/reference/updateInputSettings.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -77,7 +77,7 @@

Update input parameters of an Antares study

- 
updateInputSettings(import, opts = antaresRead::simOptions())
+ 
updateInputSettings(import, opts = antaresRead::simOptions())
@@ -88,7 +88,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/updateOptimizationSettings.html b/reference/updateOptimizationSettings.html index fc0b167d..3d3b0419 100644 --- a/reference/updateOptimizationSettings.html +++ b/reference/updateOptimizationSettings.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -96,7 +96,7 @@

Update optimization parameters of an Antares study

number.of.cores.mode = NULL, renewable.generation.modelling = NULL, day.ahead.reserve.management = NULL, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) @@ -177,7 +177,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/updateOutputSettings.html b/reference/updateOutputSettings.html index 940e6f23..6dbba572 100644 --- a/reference/updateOutputSettings.html +++ b/reference/updateOutputSettings.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -82,7 +82,7 @@

Update output parameters of an Antares study

storenewset = NULL, archives = NULL, result.format = NULL, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) @@ -108,7 +108,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/variant-commands.html b/reference/variant-commands.html index e55cd1bb..403f7bca 100644 --- a/reference/variant-commands.html +++ b/reference/variant-commands.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -78,7 +78,7 @@

Get API commands generated

getVariantCommands(
   last = NULL,
   actions = NULL,
-  opts = antaresRead::simOptions()
+  opts = antaresRead::simOptions()
 )
 
 writeVariantCommands(
@@ -86,7 +86,7 @@ 
Get API commands generated

   last = NULL,
   actions = NULL,
   ...,
-  opts = antaresRead::simOptions()
+  opts = antaresRead::simOptions()
 )
@@ -103,7 +103,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

path
diff --git a/reference/variant.html b/reference/variant.html index 12b13123..f4dcf596 100644 --- a/reference/variant.html +++ b/reference/variant.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3 @@ -75,9 +75,9 @@

Create a study's variant

- 
createVariant(name, opts = antaresRead::simOptions())
+    
createVariant(name, opts = antaresRead::simOptions())
 
-useVariant(name, variant_id = NULL, opts = antaresRead::simOptions())

+useVariant(name, variant_id = NULL, opts = antaresRead::simOptions())
@@ -88,7 +88,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

variant_id
diff --git a/reference/write-ini.html b/reference/write-ini.html index 83f47401..c84cab42 100644 --- a/reference/write-ini.html +++ b/reference/write-ini.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -78,7 +78,7 @@

Write configuration options in file or API

writeIni(
   listData,
   pathIni,
-  opts = antaresRead::simOptions(),
+  opts = antaresRead::simOptions(),
   ...,
   default_ext = ".ini"
 )
@@ -100,7 +100,7 @@ 
Arguments

 
 
opts

 
List of simulation parameters returned by the function
-antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

 
 
 
...

diff --git a/reference/writeEconomicOptions.html b/reference/writeEconomicOptions.html
index a9fc9968..450217fc 100644
--- a/reference/writeEconomicOptions.html
+++ b/reference/writeEconomicOptions.html
@@ -19,7 +19,7 @@
       
       
         antaresEditObject
-        0.6.2
+        0.6.3
@@ -79,7 +79,7 @@

Write Economic Options

- 
writeEconomicOptions(x, opts = antaresRead::simOptions())
+ 
writeEconomicOptions(x, opts = antaresRead::simOptions())
@@ -96,7 +96,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath

+antaresRead::setSimulationPath

@@ -107,7 +107,7 @@

Examples

library(antaresRead) # Set simulation path -setSimulationPath(path = "PATH/TO/SIMULATION", simulation = "input") +setSimulationPath(path = "PATH/TO/SIMULATION", simulation = "input") # Write some economic options for areas a, b and c writeEconomicOptions(data.frame( diff --git a/reference/writeHydroValues.html b/reference/writeHydroValues.html index 6f471b42..5b909f5f 100644 --- a/reference/writeHydroValues.html +++ b/reference/writeHydroValues.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3 @@ -82,7 +82,7 @@

Write Hydro Values

type, data, overwrite = TRUE, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) @@ -116,7 +116,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath().

+antaresRead::setSimulationPath().

diff --git a/reference/writeIniHydro.html b/reference/writeIniHydro.html index 1209b644..8ca459cd 100644 --- a/reference/writeIniHydro.html +++ b/reference/writeIniHydro.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -77,7 +77,7 @@

Edit hydro.ini values

- 
writeIniHydro(area, params, mode = "other", opts = antaresRead::simOptions())
+ 
writeIniHydro(area, params, mode = "other", opts = antaresRead::simOptions())
@@ -111,7 +111,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath().

+antaresRead::setSimulationPath().

@@ -126,7 +126,7 @@

Warning

Examples

if (FALSE) {
-opts <- setSimulationPath(studypath, simulation = "input")
+opts <- setSimulationPath(studypath, simulation = "input")
 createArea("fictive_area") 
 writeIniHydro(area = "fictive_area"
 , params = list("leeway low" = 2.5, "leeway up" = 25))
diff --git a/reference/writeInputTS.html b/reference/writeInputTS.html
index d2a0ac7b..6e5fd69d 100644
--- a/reference/writeInputTS.html
+++ b/reference/writeInputTS.html
@@ -18,7 +18,7 @@
       
       
         antaresEditObject
-        0.6.2
+        0.6.3
@@ -83,7 +83,7 @@

Write input time series

area = NULL, link = NULL, overwrite = TRUE, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() )
@@ -118,7 +118,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/writeMiscGen.html b/reference/writeMiscGen.html index 6eac3050..7e9746bc 100644 --- a/reference/writeMiscGen.html +++ b/reference/writeMiscGen.html @@ -17,7 +17,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -75,7 +75,7 @@

Write Misc Gen data

- 
writeMiscGen(data, area, opts = antaresRead::simOptions())
+ 
writeMiscGen(data, area, opts = antaresRead::simOptions())
@@ -90,7 +90,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

diff --git a/reference/writeOutputValues.html b/reference/writeOutputValues.html index 33b12a0e..8c08fbc7 100644 --- a/reference/writeOutputValues.html +++ b/reference/writeOutputValues.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3
@@ -88,7 +88,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath()

+antaresRead::setSimulationPath()

@@ -98,8 +98,8 @@

Examples

library(antaresRead) library(data.table) -opts <- setSimulationPath("my_study") -data <- readAntares(links = "all", areas = "all", clusters = "all") +opts <- setSimulationPath("my_study") +data <- readAntares(links = "all", areas = "all", clusters = "all") writeOutputValues(data) } diff --git a/reference/writeSeriesPrepro.html b/reference/writeSeriesPrepro.html index 9b919c98..d8c24596 100644 --- a/reference/writeSeriesPrepro.html +++ b/reference/writeSeriesPrepro.html @@ -19,7 +19,7 @@ antaresEditObject - 0.6.2 + 0.6.3 @@ -87,7 +87,7 @@

Write prepro data

translation = NULL, conversion = NULL, overwrite = TRUE, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) @@ -129,7 +129,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath().

+antaresRead::setSimulationPath().

diff --git a/reference/writeWaterValues.html b/reference/writeWaterValues.html index 53d1db0d..c48f8c72 100644 --- a/reference/writeWaterValues.html +++ b/reference/writeWaterValues.html @@ -18,7 +18,7 @@ antaresEditObject - 0.6.2 + 0.6.3 @@ -81,7 +81,7 @@

Write water values

area, data = NULL, overwrite = TRUE, - opts = antaresRead::simOptions() + opts = antaresRead::simOptions() ) @@ -105,7 +105,7 @@

Arguments

opts

List of simulation parameters returned by the function -antaresRead::setSimulationPath().

+antaresRead::setSimulationPath().

diff --git a/sitemap.xml b/sitemap.xml index 54a98349..dbc24d50 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -118,11 +118,14 @@ /reference/createPSP.html - /reference/create_referential_series_type.html + /reference/create_scb_referential_series_type.html /reference/deleteStudy.html + + /reference/detect_pattern_in_binding_constraint.html + /reference/dicoGeneralSettings.html