diff --git a/404.html b/404.html index 61980914..1ae6f2ae 100644 --- a/404.html +++ b/404.html @@ -32,7 +32,7 @@ antaresRead - 2.7.1 + 2.7.2 diff --git a/LICENSE-text.html b/LICENSE-text.html index 4d7135ec..744748f1 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2 diff --git a/articles/antaresRead.html b/articles/antaresRead.html index 690fd937..9f3148bc 100644 --- a/articles/antaresRead.html +++ b/articles/antaresRead.html @@ -32,7 +32,7 @@ antaresRead - 2.7.1 + 2.7.2 @@ -72,9 +72,9 @@

The ‘antaresRead’ Package

François Guillem

-

2024-09-02

+

2024-09-16

- Source: vignettes/antaresRead.Rmd + Source: vignettes/antaresRead.Rmd diff --git a/articles/index.html b/articles/index.html index 8858f697..6a73a46a 100644 --- a/articles/index.html +++ b/articles/index.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2 diff --git a/authors.html b/authors.html index 5d658cf5..ceb3e0df 100644 --- a/authors.html +++ b/authors.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2 @@ -111,20 +111,20 @@

Authors and Citation

Citation

- Source: DESCRIPTION + Source: DESCRIPTION

Vargas T, ZAWAM J, Guillem F, Thieurmel B, Robert T (2024). antaresRead: Import, Manipulate and Explore the Results of an 'Antares' Simulation. -R package version 2.7.1, https://rte-antares-rpackage.github.io/antaresRead/, https://github.com/rte-antares-rpackage/antaresRead. +R package version 2.7.2, https://rte-antares-rpackage.github.io/antaresRead/, https://github.com/rte-antares-rpackage/antaresRead. 

@Manual{,
   title = {antaresRead: Import, Manipulate and Explore the Results of an 'Antares' Simulation},
   author = {Tatiana Vargas and Jalal-Edine ZAWAM and Francois Guillem and Benoit Thieurmel and Titouan Robert},
   year = {2024},
-  note = {R package version 2.7.1, https://rte-antares-rpackage.github.io/antaresRead/},
+  note = {R package version 2.7.2, https://rte-antares-rpackage.github.io/antaresRead/},
   url = {https://github.com/rte-antares-rpackage/antaresRead},
 }
diff --git a/index.html b/index.html index 38e30845..fe710bfd 100644 --- a/index.html +++ b/index.html @@ -33,7 +33,7 @@ antaresRead - 2.7.1 + 2.7.2 @@ -184,7 +184,6 @@

Contributing:) setwd(saveWd) -

You must also change the h5 file here.

ANTARES : @@ -244,16 +243,7 @@

Developers

-
-

Dev status

- -
+ diff --git a/news/index.html b/news/index.html index 6eb11078..0834297c 100644 --- a/news/index.html +++ b/news/index.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2 @@ -47,9 +47,27 @@

Changelog

- Source: NEWS.md + Source: NEWS.md
+
+

antaresRead 2.7.22024-09-12

+

NEW FEATURES:

+
  • New function readAntaresSTClusters() +
    • +
  • +fread_antares() shiny compatible with a conditional processing of the error messages
    • +

BREAKING CHANGES :

+

BUGFIXES :

+

antaresRead 2.7.12024-08-30

NEW FEATURES:

diff --git a/pkgdown.yml b/pkgdown.yml index 1f67f736..163ddfda 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -3,4 +3,4 @@ pkgdown: 2.1.0 pkgdown_sha: ~ articles: antaresRead: antaresRead.html -last_built: 2024-09-02T09:00Z +last_built: 2024-09-16T08:09Z diff --git a/reference/API-methods.html b/reference/API-methods.html index fe5dd90d..02fd1c58 100644 --- a/reference/API-methods.html +++ b/reference/API-methods.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -47,7 +47,7 @@

API methods

- Source: R/API-methods.R + Source: R/API-methods.R
diff --git a/reference/aggregatate_mc_all.html b/reference/aggregatate_mc_all.html index 3a132639..b9cae263 100644 --- a/reference/aggregatate_mc_all.html +++ b/reference/aggregatate_mc_all.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -47,7 +47,7 @@

Creation of Mc_all new (only antares > V6)

- Source: R/aggregateResult.R + Source: R/aggregateResult.R
diff --git a/reference/antaresRead-package.html b/reference/antaresRead-package.html index 38c073bd..8f013a63 100644 --- a/reference/antaresRead-package.html +++ b/reference/antaresRead-package.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -47,7 +47,7 @@

antaresRead: Import, Manipulate and Explore the Results of an 'Antares' Simulation

- Source: R/antaresRead-package.R + Source: R/antaresRead-package.R
diff --git a/reference/as.antaresDataList.html b/reference/as.antaresDataList.html index 2ac835a9..409b4143 100644 --- a/reference/as.antaresDataList.html +++ b/reference/as.antaresDataList.html @@ -21,7 +21,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -51,7 +51,7 @@

Convert objects to antaresDataTable

- Source: R/asAntaresDataList.R + Source: R/asAntaresDataList.R
diff --git a/reference/as.antaresDataTable.html b/reference/as.antaresDataTable.html index bcaa1b0f..2042adf0 100644 --- a/reference/as.antaresDataTable.html +++ b/reference/as.antaresDataTable.html @@ -21,7 +21,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -51,7 +51,7 @@

Convert objects to antaresDataTable

- Source: R/asAntaresDataTable.R + Source: R/asAntaresDataTable.R
diff --git a/reference/changeTimeStep.html b/reference/changeTimeStep.html index 8ca12d3a..568019f0 100644 --- a/reference/changeTimeStep.html +++ b/reference/changeTimeStep.html @@ -19,7 +19,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -49,7 +49,7 @@

Change the timestep of an output

- Source: R/changeTimeStep.R + Source: R/changeTimeStep.R
diff --git a/reference/copyToClipboard.html b/reference/copyToClipboard.html index a783247b..c7041c83 100644 --- a/reference/copyToClipboard.html +++ b/reference/copyToClipboard.html @@ -18,7 +18,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -48,7 +48,7 @@

Copy data to the clipboard

- Source: R/copyToClipboard.R + Source: R/copyToClipboard.R
diff --git a/reference/dot-writeIni.html b/reference/dot-writeIni.html index ae66b984..b63a4b8a 100644 --- a/reference/dot-writeIni.html +++ b/reference/dot-writeIni.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -47,7 +47,7 @@

Write ini file from list obtain by antaresRead::readIniFile and modify by user

- Source: R/aggregateResult.R + Source: R/aggregateResult.R
diff --git a/reference/extractDataList.html b/reference/extractDataList.html index 74303c47..8cd69315 100644 --- a/reference/extractDataList.html +++ b/reference/extractDataList.html @@ -21,7 +21,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -51,7 +51,7 @@

Format data PPSE-style

- Source: R/extractDataList.R + Source: R/extractDataList.R
diff --git a/reference/getAreas.html b/reference/getAreas.html index 138f633f..d4b6c7f3 100644 --- a/reference/getAreas.html +++ b/reference/getAreas.html @@ -19,7 +19,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -49,7 +49,7 @@

Select and exclude areas

- Source: R/getAreas.R + Source: R/getAreas.R
diff --git a/reference/getGeographicTrimming.html b/reference/getGeographicTrimming.html index 506ad94b..a01baf95 100644 --- a/reference/getGeographicTrimming.html +++ b/reference/getGeographicTrimming.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -47,7 +47,7 @@

Read geographic trimming (filtering) options

- Source: R/getGeographicTrimming.R + Source: R/getGeographicTrimming.R
diff --git a/reference/getIdCols.html b/reference/getIdCols.html index 9882be59..84f6c70f 100644 --- a/reference/getIdCols.html +++ b/reference/getIdCols.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -47,7 +47,7 @@

get Id columns

- Source: R/getIds.R + Source: R/getIds.R
diff --git a/reference/getLinks.html b/reference/getLinks.html index aee8d332..88fc0e1b 100644 --- a/reference/getLinks.html +++ b/reference/getLinks.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -47,7 +47,7 @@

Retrieve links connected to a set of areas

- Source: R/getLinks.R + Source: R/getLinks.R
diff --git a/reference/hvdcModification.html b/reference/hvdcModification.html index 71476331..27f57e6d 100644 --- a/reference/hvdcModification.html +++ b/reference/hvdcModification.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -47,7 +47,7 @@

hvdc straitement

- Source: R/hvdcModification.R + Source: R/hvdcModification.R
diff --git a/reference/index.html b/reference/index.html index 8e2cf47d..fa2d7deb 100644 --- a/reference/index.html +++ b/reference/index.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -125,6 +125,10 @@

All functions readAntaresClusters()

Read output for a list of clusters

+ +

readAntaresSTClusters()

+ +

Read output for a list of short-term storage clusters

readBindingConstraints()

diff --git a/reference/mergeDigests.html b/reference/mergeDigests.html index 86637be6..1507fe1e 100644 --- a/reference/mergeDigests.html +++ b/reference/mergeDigests.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2

@@ -47,7 +47,7 @@

Merge two digests

- Source: R/digest.R + Source: R/digest.R
diff --git a/reference/ponderateMcAggregation.html b/reference/ponderateMcAggregation.html index 58a162aa..d37dac64 100644 --- a/reference/ponderateMcAggregation.html +++ b/reference/ponderateMcAggregation.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -47,7 +47,7 @@

Mcyear aggregation weigthed by wd

- Source: R/ponderateMcAggregation.R + Source: R/ponderateMcAggregation.R
diff --git a/reference/read-ini.html b/reference/read-ini.html index 8f358853..5ba769e9 100644 --- a/reference/read-ini.html +++ b/reference/read-ini.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -47,7 +47,7 @@

Read configuration options from file or API

- Source: R/readIniFile.R + Source: R/readIniFile.R
diff --git a/reference/readAntares.html b/reference/readAntares.html index 7aee5e8a..355211b5 100644 --- a/reference/readAntares.html +++ b/reference/readAntares.html @@ -27,7 +27,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -57,7 +57,7 @@

Read the data of an Antares simulation

- Source: R/readAntares.R + Source: R/readAntares.R
@@ -188,7 +188,7 @@

Arguments

similar to mustRunTotal except it also takes into account the production induced by the minimum stable power of the units of a cluster. More precisely, for a given cluster and a given time step, it is equal to -min(NODU x min.stable.power, mustRunTotal).

+min(NODU x min-stable-power, mustRunTotal).

thermalModulation
diff --git a/reference/readAntaresAreas.html b/reference/readAntaresAreas.html index 161da9dd..56439885 100644 --- a/reference/readAntaresAreas.html +++ b/reference/readAntaresAreas.html @@ -18,7 +18,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -48,7 +48,7 @@

Read output for a list of areas

- Source: R/readAntares.R + Source: R/readAntares.R
diff --git a/reference/readAntaresClusters.html b/reference/readAntaresClusters.html index ce178747..60c64b7b 100644 --- a/reference/readAntaresClusters.html +++ b/reference/readAntaresClusters.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -47,7 +47,7 @@

Read output for a list of clusters

- Source: R/readAntaresClusters.R + Source: R/readAntaresClusters.R
diff --git a/reference/readAntaresSTClusters.html b/reference/readAntaresSTClusters.html new file mode 100644 index 00000000..02d404d5 --- /dev/null +++ b/reference/readAntaresSTClusters.html @@ -0,0 +1,128 @@ + +Read output for a list of short-term storage clusters — readAntaresSTClusters • antaresRead + + +
+
+ + + +
+
+
+

Read output for a list of short-term storage clusters

+ Source: R/readAntaresClusters.R + +
+ +
+

Read output for a list of short-term storage clusters

+
+ +
+ 
readAntaresSTClusters(
+  clustersST,
+  selected = c("P.injection", "levels", "P.withdrawal"),
+  timeStep = c("hourly", "daily", "weekly", "monthly", "annual"),
+  opts = simOptions(),
+  parallel = FALSE,
+  showProgress = TRUE
+)
+
+ +
+

Arguments

+ + +
clustersST
+

vector of short-term storage clusters to be imported

+ + +
selected
+

vector of thematic trimming

+ + +
timeStep
+

Resolution of the data to import: hourly (default), daily, +weekly, monthly or annual.

+ + +
opts
+

list of simulation parameters returned by the function +setSimulationPath

+ + +
parallel
+

Should the importation be parallelized ? (See details)

+ + +
showProgress
+

If TRUE the function displays information about the progress of the +importation.

+ +
+
+

Value

+

data.table of results for short-term storage clusters

+
+ +
+ +
+ + +
+

Developed by Tatiana Vargas, Jalal-Edine ZAWAM, Francois Guillem, Benoit Thieurmel, Titouan Robert.

+
+ +
+

Site built with pkgdown 2.1.0.

+
+ +
+ + + + + + + + diff --git a/reference/readBindingConstraints.html b/reference/readBindingConstraints.html index baee6cb6..ff621c68 100644 --- a/reference/readBindingConstraints.html +++ b/reference/readBindingConstraints.html @@ -21,7 +21,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -51,7 +51,7 @@

Read binding constraints

- Source: R/readBindingConstraints.R + Source: R/readBindingConstraints.R
diff --git a/reference/readClusterDesc.html b/reference/readClusterDesc.html index 394548b6..7caf66d3 100644 --- a/reference/readClusterDesc.html +++ b/reference/readClusterDesc.html @@ -20,7 +20,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -50,7 +50,7 @@

Import clusters description

- Source: R/readClusterDesc.R + Source: R/readClusterDesc.R
@@ -107,6 +107,7 @@

Value

readClusterDesc : read thermal clusters

readClusterResDesc : read renewable clusters (Antares >= V8.1)

readClusterSTDesc : read st-storage clusters (Antares >= V8.6)

+

If you have no clusters properties, Null data.table (0 rows and 0 cols) is returned.

diff --git a/reference/readDigestFile.html b/reference/readDigestFile.html index 323ccdf3..76bfdf65 100644 --- a/reference/readDigestFile.html +++ b/reference/readDigestFile.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -47,7 +47,7 @@

Read digest file

- Source: R/digest.R + Source: R/digest.R
diff --git a/reference/readInputRES.html b/reference/readInputRES.html index 38e6e649..dddb45ad 100644 --- a/reference/readInputRES.html +++ b/reference/readInputRES.html @@ -19,7 +19,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -49,7 +49,7 @@

Read Input RES time series

- Source: R/readInputClusters.R + Source: R/readInputClusters.R
diff --git a/reference/readInputTS.html b/reference/readInputTS.html index ce4f5a66..9633739a 100644 --- a/reference/readInputTS.html +++ b/reference/readInputTS.html @@ -20,7 +20,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -50,7 +50,7 @@

Read Input time series

- Source: R/readInputTS.R + Source: R/readInputTS.R
diff --git a/reference/readInputThermal.html b/reference/readInputThermal.html index 0c5e8e19..717b3f35 100644 --- a/reference/readInputThermal.html +++ b/reference/readInputThermal.html @@ -19,7 +19,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -49,7 +49,7 @@

Read Input thermal time series

- Source: R/readInputClusters.R + Source: R/readInputClusters.R
diff --git a/reference/readLayout.html b/reference/readLayout.html index 5da93a09..aacd5027 100644 --- a/reference/readLayout.html +++ b/reference/readLayout.html @@ -21,7 +21,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -51,7 +51,7 @@

Read areas layout

- Source: R/readLayout.R + Source: R/readLayout.R
diff --git a/reference/readOptimCriteria.html b/reference/readOptimCriteria.html index df6132b2..bc5f6917 100644 --- a/reference/readOptimCriteria.html +++ b/reference/readOptimCriteria.html @@ -19,7 +19,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -49,7 +49,7 @@

Read Optimization Criteria

- Source: R/read_optim_criteria.R + Source: R/read_optim_criteria.R
diff --git a/reference/removeVirtualAreas.html b/reference/removeVirtualAreas.html index ae36b50c..ae3ef7fb 100644 --- a/reference/removeVirtualAreas.html +++ b/reference/removeVirtualAreas.html @@ -19,7 +19,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -49,7 +49,7 @@

Remove virtual areas

- Source: R/removeVirtualAreas.R + Source: R/removeVirtualAreas.R
diff --git a/reference/setAlias.html b/reference/setAlias.html index 2422b51d..7411a302 100644 --- a/reference/setAlias.html +++ b/reference/setAlias.html @@ -24,7 +24,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -54,7 +54,7 @@

show aliases for variables

- Source: R/showAliases.R + Source: R/showAliases.R
diff --git a/reference/setHvdcAreas.html b/reference/setHvdcAreas.html index b24352cd..52bcce6e 100644 --- a/reference/setHvdcAreas.html +++ b/reference/setHvdcAreas.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -47,7 +47,7 @@

Set hvdc areas

- Source: R/setHvdcAreas.R + Source: R/setHvdcAreas.R
diff --git a/reference/setRam.html b/reference/setRam.html index bf3881af..c7202822 100644 --- a/reference/setRam.html +++ b/reference/setRam.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -47,7 +47,7 @@

Specify RAM limit

- Source: R/giveSize.R + Source: R/giveSize.R
diff --git a/reference/setSimulationPath.html b/reference/setSimulationPath.html index b6500b37..429284d0 100644 --- a/reference/setSimulationPath.html +++ b/reference/setSimulationPath.html @@ -20,7 +20,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -50,7 +50,7 @@

Set Path to an Antares simulation

- Source: R/setSimulationPath.R, R/utils_api.R + Source: R/setSimulationPath.R, R/setSimulationPathAPI.R
diff --git a/reference/setTimeoutAPI.html b/reference/setTimeoutAPI.html index 03342d4a..294d0001 100644 --- a/reference/setTimeoutAPI.html +++ b/reference/setTimeoutAPI.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -47,7 +47,7 @@

Change API Timeout

- Source: R/utils_api.R + Source: R/utils_api.R
diff --git a/reference/simOptions.html b/reference/simOptions.html index 94701814..66cfd93c 100644 --- a/reference/simOptions.html +++ b/reference/simOptions.html @@ -19,7 +19,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -49,7 +49,7 @@

Extract simulation options

- Source: R/simOptions.R + Source: R/simOptions.R
diff --git a/reference/subset.antaresDataList.html b/reference/subset.antaresDataList.html index 0e56cc58..47c87db1 100644 --- a/reference/subset.antaresDataList.html +++ b/reference/subset.antaresDataList.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -47,7 +47,7 @@

Subset an antaresDataList

- Source: R/subset.R + Source: R/subset.R
diff --git a/reference/summary.bindingConstraints.html b/reference/summary.bindingConstraints.html index 4027c2e4..e1e2ae02 100644 --- a/reference/summary.bindingConstraints.html +++ b/reference/summary.bindingConstraints.html @@ -18,7 +18,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -48,7 +48,7 @@

Display equation of binding constraint

- Source: R/readBindingConstraints.R + Source: R/readBindingConstraints.R
diff --git a/reference/viewAntares.html b/reference/viewAntares.html index 49960ece..198efb89 100644 --- a/reference/viewAntares.html +++ b/reference/viewAntares.html @@ -18,7 +18,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -48,7 +48,7 @@

View the content of an antares output

- Source: R/viewAntares.R + Source: R/viewAntares.R
diff --git a/reference/writeDigest.html b/reference/writeDigest.html index 52e6b118..bd569410 100644 --- a/reference/writeDigest.html +++ b/reference/writeDigest.html @@ -17,7 +17,7 @@ antaresRead - 2.7.1 + 2.7.2
@@ -47,7 +47,7 @@

Write digest file

- Source: R/digest.R + Source: R/digest.R
diff --git a/sitemap.xml b/sitemap.xml index bfa987ce..5e041396 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -27,6 +27,7 @@ /reference/readAntares.html /reference/readAntaresAreas.html /reference/readAntaresClusters.html +/reference/readAntaresSTClusters.html /reference/readBindingConstraints.html /reference/readClusterDesc.html /reference/readDigestFile.html