From ccaab4883c2a6106c74d5e34095980f035d75213 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Berthet?= Date: Thu, 6 Apr 2023 11:01:02 +0200 Subject: [PATCH] update doc + site (#202) --------- Co-authored-by: BERTHET Clement Ext --- README.md | 3 +- docs/404.html | 4 +- docs/LICENSE-text.html | 4 +- docs/articles/antaresH5.html | 6 +- docs/articles/antaresRead.html | 6 +- docs/articles/index.html | 4 +- docs/authors.html | 8 +- docs/index.html | 9 +- docs/news/index.html | 13 +- docs/pkgdown.yml | 4 +- docs/reference/API-methods.html | 4 +- docs/reference/aggregatate_mc_all.html | 4 +- docs/reference/aggregatate_mc_all_old.html | 4 +- docs/reference/as.antaresDataList.html | 4 +- docs/reference/as.antaresDataTable.html | 4 +- docs/reference/changeTimeStep.html | 4 +- docs/reference/copyToClipboard.html | 4 +- docs/reference/dot-getOptionsH5.html | 102 +++++++++++ docs/reference/dot-h5ReadAntares.html | 194 +++++++++++++++++++++ docs/reference/dot-writeAntaresH5Fun.html | 116 ++++++++++++ docs/reference/dot-writeIni.html | 4 +- docs/reference/extractDataList.html | 4 +- docs/reference/getAreas.html | 4 +- docs/reference/getGeographicTrimming.html | 4 +- docs/reference/getIdCols.html | 4 +- docs/reference/getLinks.html | 4 +- docs/reference/hvdcModification.html | 4 +- docs/reference/index.html | 4 +- docs/reference/isH5Opts.html | 4 +- docs/reference/mergeDigests.html | 4 +- docs/reference/ponderateMcAggregation.html | 4 +- docs/reference/read-ini.html | 4 +- docs/reference/readAntares.html | 4 +- docs/reference/readAntaresAreas.html | 4 +- docs/reference/readAntaresClusters.html | 4 +- docs/reference/readBindingConstraints.html | 4 +- docs/reference/readClusterDesc.html | 4 +- docs/reference/readDigestFile.html | 4 +- docs/reference/readInputRES.html | 4 +- docs/reference/readInputTS.html | 4 +- docs/reference/readInputThermal.html | 4 +- docs/reference/readLayout.html | 4 +- docs/reference/readOptimCriteria.html | 4 +- docs/reference/removeVirtualAreas.html | 4 +- docs/reference/setAlias.html | 4 +- docs/reference/setHvdcAreas.html | 4 +- docs/reference/setRam.html | 4 +- docs/reference/setSimulationPath.html | 14 +- docs/reference/setTimeoutAPI.html | 4 +- docs/reference/simOptions.html | 4 +- docs/reference/subset.antaresDataList.html | 4 +- docs/reference/viewAntares.html | 4 +- docs/reference/writeAntaresH5.html | 4 +- docs/reference/writeDigest.html | 4 +- docs/sitemap.xml | 9 + 55 files changed, 541 insertions(+), 115 deletions(-) create mode 100644 docs/reference/dot-getOptionsH5.html create mode 100644 docs/reference/dot-h5ReadAntares.html create mode 100644 docs/reference/dot-writeAntaresH5Fun.html diff --git a/README.md b/README.md index e42c7274..9a7f8238 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,8 @@ [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/antaresRead)](https://cran.r-project.org/package=antaresRead) [![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable) [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) -[![R-CMD-check](https://github.com/rte-antares-rpackage/antaresRead/workflows/R-CMD-check/badge.svg)](https://github.com/rte-antares-rpackage/antaresRead/actions) -[![Codecov test coverage](https://codecov.io/gh/rte-antares-rpackage/antaresRead/branch/master/graph/badge.svg)](https://app.codecov.io/gh/rte-antares-rpackage/antaresRead?branch=master) [![R-CMD-check](https://github.com/rte-antares-rpackage/antaresRead/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rte-antares-rpackage/antaresRead/actions/workflows/R-CMD-check.yaml) +[![Codecov test coverage](https://codecov.io/gh/rte-antares-rpackage/antaresRead/branch/master/graph/badge.svg)](https://app.codecov.io/gh/rte-antares-rpackage/antaresRead?branch=master) diff --git a/docs/404.html b/docs/404.html index 24e28081..26c9ca66 100644 --- a/docs/404.html +++ b/docs/404.html @@ -32,7 +32,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -103,7 +103,7 @@

Page not found (404)

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index 8dcc43f2..00195c59 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -77,7 +77,7 @@

License

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/articles/antaresH5.html b/docs/articles/antaresH5.html index 606dca2d..7f85bdeb 100644 --- a/docs/articles/antaresH5.html +++ b/docs/articles/antaresH5.html @@ -33,7 +33,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -84,7 +84,7 @@

Use h5 file format with ‘antaresRead’

Titouan Robert

-

2023-03-10

+

2023-04-06

Source: vignettes/antaresH5.Rmd @@ -219,7 +219,7 @@

Use h5 opts for vizualisation

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/articles/antaresRead.html b/docs/articles/antaresRead.html index f3e6d2c9..fb11ad30 100644 --- a/docs/articles/antaresRead.html +++ b/docs/articles/antaresRead.html @@ -33,7 +33,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -84,7 +84,7 @@

The ‘antaresRead’ Package

François Guillem

-

2023-03-10

+

2023-04-06

Source: vignettes/antaresRead.Rmd @@ -212,7 +212,7 @@

Other useful functions

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/articles/index.html b/docs/articles/index.html index 698e3ad2..4e612b4e 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -77,7 +77,7 @@

All vignettes

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/authors.html b/docs/authors.html index acb76732..d37f8511 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -112,13 +112,13 @@

Citation

Bachelier V, ZAWAM J, Guillem F, Thieurmel B, Robert T (2023). antaresRead: Import, Manipulate and Explore the Results of an 'Antares' Simulation. -R package version 2.5.0, https://github.com/rte-antares-rpackage/antaresRead. +R package version 2.5.1, https://github.com/rte-antares-rpackage/antaresRead. 

@Manual{,
   title = {antaresRead: Import, Manipulate and Explore the Results of an 'Antares' Simulation},
   author = {Veronique Bachelier and Jalal-Edine ZAWAM and Francois Guillem and Benoit Thieurmel and Titouan Robert},
   year = {2023},
-  note = {R package version 2.5.0},
+  note = {R package version 2.5.1},
   url = {https://github.com/rte-antares-rpackage/antaresRead},
 }
@@ -133,7 +133,7 @@

Citation

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/index.html b/docs/index.html index bef72b2f..34a7de19 100644 --- a/docs/index.html +++ b/docs/index.html @@ -35,7 +35,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -97,7 +97,7 @@

Installationinstall.packages("antaresRead")

You can also install the last development version from Github:

-devtools::install_github("rte-antares-rpackage/antaresRead")
+devtools::install_github("rte-antares-rpackage/antaresRead")

To display the help of the package and see all the functions it provides, type:

 help(package="antaresRead")
@@ -257,9 +257,8 @@

Dev status

  • CRAN_Status_Badge
  • Lifecycle: stable
  • Project Status: Active – The project has reached a stable, usable state and is being actively developed.
    • -
  • R-CMD-check
    • -
  • Codecov test coverage
  • R-CMD-check
    • +
  • Codecov test coverage
    • @@ -274,7 +273,7 @@

    Dev status

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/news/index.html b/docs/news/index.html index 98c33a34..7fd4c1b8 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -60,11 +60,18 @@

    Changelog

    Source: NEWS.md +
    +

    antaresRead 2.5.1

    +

    BUGFIXES:

    +

    DEV:

    +
    • Added new test study v8.5.
      • +
    • Package no longer tested on study v6.
      • +

    antaresRead 2.5.0

    NEW FEATURES:

    • Full support of studies up to v8.5
      • -
    • Function readAntares() has new argument for binding constraints output (v8.4+)
      • +
    • Function readAntares() has new argument for binding constraints output (v8.4+) (#173)
    • New functions readDigestFile(), mergeDigests() and writeDigest() to manipulate digest file.
    • Mc-all aggregation :
      • added computation of record years
      • merges original digest.txt with the one created
        • @@ -417,7 +424,7 @@

        antar

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index f46655b1..d821c3d7 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,8 +1,8 @@ pandoc: 2.11.2 -pkgdown: 2.0.7 +pkgdown: 2.0.6 pkgdown_sha: ~ articles: antaresH5: antaresH5.html antaresRead: antaresRead.html -last_built: 2023-03-10T01:06Z +last_built: 2023-04-06T08:38Z diff --git a/docs/reference/API-methods.html b/docs/reference/API-methods.html index 2addfd8c..f24efb35 100644 --- a/docs/reference/API-methods.html +++ b/docs/reference/API-methods.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -126,7 +126,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/aggregatate_mc_all.html b/docs/reference/aggregatate_mc_all.html index 4ce009ec..7c9171d5 100644 --- a/docs/reference/aggregatate_mc_all.html +++ b/docs/reference/aggregatate_mc_all.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -150,7 +150,7 @@

    Arguments

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/aggregatate_mc_all_old.html b/docs/reference/aggregatate_mc_all_old.html index fd2551fa..d83f453e 100644 --- a/docs/reference/aggregatate_mc_all_old.html +++ b/docs/reference/aggregatate_mc_all_old.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -148,7 +148,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/as.antaresDataList.html b/docs/reference/as.antaresDataList.html index 87745664..e7388aeb 100644 --- a/docs/reference/as.antaresDataList.html +++ b/docs/reference/as.antaresDataList.html @@ -21,7 +21,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -141,7 +141,7 @@

    Value

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/as.antaresDataTable.html b/docs/reference/as.antaresDataTable.html index d276ede8..a6d1efbf 100644 --- a/docs/reference/as.antaresDataTable.html +++ b/docs/reference/as.antaresDataTable.html @@ -21,7 +21,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -125,7 +125,7 @@

    Value

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/changeTimeStep.html b/docs/reference/changeTimeStep.html index 1d601203..0a0ae894 100644 --- a/docs/reference/changeTimeStep.html +++ b/docs/reference/changeTimeStep.html @@ -19,7 +19,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -143,7 +143,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/copyToClipboard.html b/docs/reference/copyToClipboard.html index 733d6650..c7830aa7 100644 --- a/docs/reference/copyToClipboard.html +++ b/docs/reference/copyToClipboard.html @@ -18,7 +18,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -129,7 +129,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/dot-getOptionsH5.html b/docs/reference/dot-getOptionsH5.html new file mode 100644 index 00000000..f3c3ab93 --- /dev/null +++ b/docs/reference/dot-getOptionsH5.html @@ -0,0 +1,102 @@ + +Get H5 options — .getOptionsH5 • antaresRead + + +
    +
    + + + +
    +
    +
    +

    Get H5 options

    + Source: R/h5_setSimulationPathH5.R + +
    + +
    +

    Get H5 options

    +
    + +
    + 
    .getOptionsH5(path)
    +
    + +
    +

    Arguments

    +
    path
    +

    character path of h5 file

    + +
    + +
    + +
    + + +
    +

    Developed by Veronique Bachelier, Jalal-Edine ZAWAM, Francois Guillem, Benoit Thieurmel, Titouan Robert.

    +
    + +
    +

    Site built with pkgdown 2.0.6.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/dot-h5ReadAntares.html b/docs/reference/dot-h5ReadAntares.html new file mode 100644 index 00000000..cda40d2f --- /dev/null +++ b/docs/reference/dot-h5ReadAntares.html @@ -0,0 +1,194 @@ + +Read data — .h5ReadAntares • antaresRead + + +
    +
    + + + +
    +
    +
    +

    Read data

    + Source: R/h5_antaresReadH5.R + +
    + +
    +

    Read data

    +
    + +
    + 
    .h5ReadAntares(
+  path,
+  areas = NULL,
+  links = NULL,
+  clusters = NULL,
+  districts = NULL,
+  mcYears = NULL,
+  misc = FALSE,
+  thermalAvailabilities = FALSE,
+  hydroStorage = FALSE,
+  hydroStorageMaxPower = FALSE,
+  reserve = FALSE,
+  linkCapacity = FALSE,
+  mustRun = FALSE,
+  thermalModulation = FALSE,
+  timeStep = "hourly",
+  select = NULL,
+  showProgress = TRUE,
+  simplify = TRUE,
+  perf = FALSE
+)
    +
    + +
    +

    Arguments

    +
    path
    +

    character path of h5file to load

    + + +
    areas
    +

    see readAntares

    + + +
    links
    +

    see readAntares

    + + +
    clusters
    +

    see readAntares

    + + +
    districts
    +

    see readAntares

    + + +
    mcYears
    +

    see readAntares

    + + +
    misc
    +

    see readAntares

    + + +
    thermalAvailabilities
    +

    see readAntares

    + + +
    hydroStorage
    +

    see readAntares

    + + +
    hydroStorageMaxPower
    +

    see readAntares

    + + +
    reserve
    +

    see readAntares

    + + +
    linkCapacity
    +

    see readAntares

    + + +
    mustRun
    +

    see readAntares

    + + +
    thermalModulation
    +

    see readAntares

    + + +
    timeStep
    +

    see readAntares

    + + +
    select
    +

    see readAntares

    + + +
    showProgress
    +

    see readAntares

    + + +
    simplify
    +

    see readAntares

    + + +
    perf
    +

    boolean, eval performance during developpement time, to remove

    + +
    + +
    + +
    + + +
    +

    Developed by Veronique Bachelier, Jalal-Edine ZAWAM, Francois Guillem, Benoit Thieurmel, Titouan Robert.

    +
    + +
    +

    Site built with pkgdown 2.0.6.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/dot-writeAntaresH5Fun.html b/docs/reference/dot-writeAntaresH5Fun.html new file mode 100644 index 00000000..4e4d9a88 --- /dev/null +++ b/docs/reference/dot-writeAntaresH5Fun.html @@ -0,0 +1,116 @@ + +Convert antares output to h5 file — .writeAntaresH5Fun • antaresRead + + +
    +
    + + + +
    +
    +
    +

    Convert antares output to h5 file

    + Source: R/h5_writeH5ByYear.R + +
    + +
    +

    Convert antares output to h5 file

    +
    + +
    + 
    .writeAntaresH5Fun(
+  path,
+  timeSteps,
+  opts,
+  writeMcAll,
+  compress,
+  misc,
+  thermalAvailabilities,
+  hydroStorage,
+  hydroStorageMaxPower,
+  reserve,
+  linkCapacity,
+  mustRun,
+  thermalModulation,
+  removeVirtualAreas,
+  storageFlexibility,
+  production,
+  reassignCosts,
+  newCols,
+  supressMessages
+)
    +
    + + +
    + +
    + + +
    +

    Developed by Veronique Bachelier, Jalal-Edine ZAWAM, Francois Guillem, Benoit Thieurmel, Titouan Robert.

    +
    + +
    +

    Site built with pkgdown 2.0.6.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/dot-writeIni.html b/docs/reference/dot-writeIni.html index 8659f9fe..ea85614c 100644 --- a/docs/reference/dot-writeIni.html +++ b/docs/reference/dot-writeIni.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -109,7 +109,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/extractDataList.html b/docs/reference/extractDataList.html index 0ae87c5e..5b6e706b 100644 --- a/docs/reference/extractDataList.html +++ b/docs/reference/extractDataList.html @@ -21,7 +21,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -111,7 +111,7 @@

    Value

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/getAreas.html b/docs/reference/getAreas.html index 560b1f53..591db1d6 100644 --- a/docs/reference/getAreas.html +++ b/docs/reference/getAreas.html @@ -19,7 +19,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -157,7 +157,7 @@

    See also

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/getGeographicTrimming.html b/docs/reference/getGeographicTrimming.html index b96dbc82..60834a3b 100644 --- a/docs/reference/getGeographicTrimming.html +++ b/docs/reference/getGeographicTrimming.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -102,7 +102,7 @@

    Value

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/getIdCols.html b/docs/reference/getIdCols.html index a37b377c..44fe3bc1 100644 --- a/docs/reference/getIdCols.html +++ b/docs/reference/getIdCols.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -94,7 +94,7 @@

    Value

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/getLinks.html b/docs/reference/getLinks.html index c777f990..c8adedc8 100644 --- a/docs/reference/getLinks.html +++ b/docs/reference/getLinks.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -195,7 +195,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/hvdcModification.html b/docs/reference/hvdcModification.html index 81afaa45..fcc2fc9c 100644 --- a/docs/reference/hvdcModification.html +++ b/docs/reference/hvdcModification.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -108,7 +108,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/index.html b/docs/reference/index.html index 4f0568fb..94eb5c1a 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -236,7 +236,7 @@

    All functions
    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/isH5Opts.html b/docs/reference/isH5Opts.html index 3371f43f..667790fa 100644 --- a/docs/reference/isH5Opts.html +++ b/docs/reference/isH5Opts.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -88,7 +88,7 @@

    Arguments

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/mergeDigests.html b/docs/reference/mergeDigests.html index 5d0155c4..bd438e9a 100644 --- a/docs/reference/mergeDigests.html +++ b/docs/reference/mergeDigests.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -103,7 +103,7 @@

    See also

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/ponderateMcAggregation.html b/docs/reference/ponderateMcAggregation.html index e9d02844..db791dc5 100644 --- a/docs/reference/ponderateMcAggregation.html +++ b/docs/reference/ponderateMcAggregation.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -107,7 +107,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/read-ini.html b/docs/reference/read-ini.html index 04016501..172fc3f7 100644 --- a/docs/reference/read-ini.html +++ b/docs/reference/read-ini.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -153,7 +153,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/readAntares.html b/docs/reference/readAntares.html index 32d58fc5..dd4dc680 100644 --- a/docs/reference/readAntares.html +++ b/docs/reference/readAntares.html @@ -26,7 +26,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -355,7 +355,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/readAntaresAreas.html b/docs/reference/readAntaresAreas.html index 095111ae..9367bfd4 100644 --- a/docs/reference/readAntaresAreas.html +++ b/docs/reference/readAntaresAreas.html @@ -18,7 +18,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -152,7 +152,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/readAntaresClusters.html b/docs/reference/readAntaresClusters.html index 834b0fef..0e6c1833 100644 --- a/docs/reference/readAntaresClusters.html +++ b/docs/reference/readAntaresClusters.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -124,7 +124,7 @@

    Value

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/readBindingConstraints.html b/docs/reference/readBindingConstraints.html index 3bce6872..0423637b 100644 --- a/docs/reference/readBindingConstraints.html +++ b/docs/reference/readBindingConstraints.html @@ -19,7 +19,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -142,7 +142,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/readClusterDesc.html b/docs/reference/readClusterDesc.html index 61027e1b..cf2f1a88 100644 --- a/docs/reference/readClusterDesc.html +++ b/docs/reference/readClusterDesc.html @@ -20,7 +20,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -157,7 +157,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/readDigestFile.html b/docs/reference/readDigestFile.html index 4d63c834..948ce022 100644 --- a/docs/reference/readDigestFile.html +++ b/docs/reference/readDigestFile.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -99,7 +99,7 @@

    Value

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/readInputRES.html b/docs/reference/readInputRES.html index 31d3f3af..9547ebdf 100644 --- a/docs/reference/readInputRES.html +++ b/docs/reference/readInputRES.html @@ -19,7 +19,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -135,7 +135,7 @@

    See also

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/readInputTS.html b/docs/reference/readInputTS.html index c6e57b64..be7e5a89 100644 --- a/docs/reference/readInputTS.html +++ b/docs/reference/readInputTS.html @@ -19,7 +19,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -222,7 +222,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/readInputThermal.html b/docs/reference/readInputThermal.html index a20cb206..98b3d015 100644 --- a/docs/reference/readInputThermal.html +++ b/docs/reference/readInputThermal.html @@ -19,7 +19,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -154,7 +154,7 @@

    See also

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/readLayout.html b/docs/reference/readLayout.html index af592fd2..d46363f3 100644 --- a/docs/reference/readLayout.html +++ b/docs/reference/readLayout.html @@ -21,7 +21,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -140,7 +140,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/readOptimCriteria.html b/docs/reference/readOptimCriteria.html index 66558cbe..03e28de1 100644 --- a/docs/reference/readOptimCriteria.html +++ b/docs/reference/readOptimCriteria.html @@ -19,7 +19,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -112,7 +112,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/removeVirtualAreas.html b/docs/reference/removeVirtualAreas.html index 025c7aeb..97e8d2f3 100644 --- a/docs/reference/removeVirtualAreas.html +++ b/docs/reference/removeVirtualAreas.html @@ -19,7 +19,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -252,7 +252,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/setAlias.html b/docs/reference/setAlias.html index 2e02fb42..d24dd8c2 100644 --- a/docs/reference/setAlias.html +++ b/docs/reference/setAlias.html @@ -24,7 +24,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -166,7 +166,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/setHvdcAreas.html b/docs/reference/setHvdcAreas.html index e16bf2b8..a17b755e 100644 --- a/docs/reference/setHvdcAreas.html +++ b/docs/reference/setHvdcAreas.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -112,7 +112,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/setRam.html b/docs/reference/setRam.html index ebb31ab4..becdc7fd 100644 --- a/docs/reference/setRam.html +++ b/docs/reference/setRam.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -97,7 +97,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/setSimulationPath.html b/docs/reference/setSimulationPath.html index 0e2597e7..acdd78af 100644 --- a/docs/reference/setSimulationPath.html +++ b/docs/reference/setSimulationPath.html @@ -20,7 +20,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -122,7 +122,7 @@

    Arguments

    httr_config
    -

    API httr configuration. See config

    +

    API httr configuration. See config

    @@ -266,21 +266,21 @@

    Examples

    # global using httr package require(httr) -set_config(verbose()) +set_config(verbose()) setSimulationPathAPI( host = "http://antares_api_adress", study_id = "study_id_on_api", token = "token" ) -reset_config() +reset_config() # or in setSimulationPathAPI setSimulationPathAPI( host = "http://antares_api_adress", study_id = "study_id_on_api", token = "token", - httr_config = config(verbose = TRUE) + httr_config = config(verbose = TRUE) ) # disable ssl certificate checking ? @@ -288,7 +288,7 @@

    Examples

    host = "http://antares_api_adress", study_id = "study_id_on_api", token = "token", - httr_config = config(ssl_verifypeer = FALSE) + httr_config = config(ssl_verifypeer = FALSE) ) # WORKING WITH MULTIPLE SIMULATIONS @@ -336,7 +336,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/setTimeoutAPI.html b/docs/reference/setTimeoutAPI.html index 2e22afc6..288817bb 100644 --- a/docs/reference/setTimeoutAPI.html +++ b/docs/reference/setTimeoutAPI.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -101,7 +101,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/simOptions.html b/docs/reference/simOptions.html index 0af20e30..859bca9e 100644 --- a/docs/reference/simOptions.html +++ b/docs/reference/simOptions.html @@ -19,7 +19,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -134,7 +134,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/subset.antaresDataList.html b/docs/reference/subset.antaresDataList.html index a6b68ba5..649e82b1 100644 --- a/docs/reference/subset.antaresDataList.html +++ b/docs/reference/subset.antaresDataList.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -140,7 +140,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/viewAntares.html b/docs/reference/viewAntares.html index 52fcac19..cd5dfb1b 100644 --- a/docs/reference/viewAntares.html +++ b/docs/reference/viewAntares.html @@ -18,7 +18,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -115,7 +115,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/writeAntaresH5.html b/docs/reference/writeAntaresH5.html index 1676a75a..246b06fc 100644 --- a/docs/reference/writeAntaresH5.html +++ b/docs/reference/writeAntaresH5.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -250,7 +250,7 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/reference/writeDigest.html b/docs/reference/writeDigest.html index 1c51fa26..640eacf2 100644 --- a/docs/reference/writeDigest.html +++ b/docs/reference/writeDigest.html @@ -17,7 +17,7 @@ antaresRead - 2.5.0 + 2.5.1 @@ -103,7 +103,7 @@

    See also

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.0.6.

    diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 4e484f25..a32ab42e 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -48,6 +48,15 @@ /reference/copyToClipboard.html + + /reference/dot-getOptionsH5.html + + + /reference/dot-h5ReadAntares.html + + + /reference/dot-writeAntaresH5Fun.html + /reference/dot-writeIni.html