From a15048ce3b2bb0468e11942d49ae86dfd99e9c00 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Berthet?= Date: Thu, 6 Apr 2023 11:03:56 +0200 Subject: [PATCH] add coverage + update doc (#81) Co-authored-by: BERTHET Clement Ext --- .Rbuildignore | 1 + .github/workflows/test-coverage.yaml | 50 ++++ README.md | 2 +- codecov.yml | 14 ++ docs/404.html | 4 +- docs/LICENSE-text.html | 4 +- docs/articles/antaresEditObject.html | 4 +- docs/articles/api-variant-management.html | 16 +- docs/articles/index.html | 4 +- docs/articles/renewables-energy-sources.html | 4 +- docs/articles/scenario-builder.html | 26 +-- docs/authors.html | 8 +- docs/index.html | 8 +- docs/news/index.html | 28 ++- docs/pkgdown.yml | 4 +- docs/reference/activateRES.html | 4 +- docs/reference/adequacyOptions.html | 4 +- docs/reference/antaresRead-reexports.html | 4 +- docs/reference/backupStudy.html | 17 +- docs/reference/check-version.html | 4 +- docs/reference/checkRemovedArea.html | 4 +- docs/reference/cleanUpOutput.html | 4 +- .../computeOtherFromHourlyMulti.html | 4 +- .../reference/computeOtherFromHourlyYear.html | 4 +- .../reference/computeTimeStampFromHourly.html | 4 +- docs/reference/convertConfigToAdq.html | 4 +- docs/reference/copyOutput.html | 4 +- docs/reference/copyStudyWeb.html | 145 ++++++++++++ docs/reference/create-binding-constraint.html | 4 +- docs/reference/create-cluster.html | 4 +- docs/reference/create-study.html | 4 +- docs/reference/createArea.html | 4 +- docs/reference/createClusterBulk.html | 214 ++++++++++++++++++ docs/reference/createDSR.html | 4 +- docs/reference/createDistrict.html | 4 +- docs/reference/createLink.html | 4 +- docs/reference/createPSP.html | 4 +- docs/reference/deleteStudy.html | 108 +++++++++ docs/reference/dicoGeneralSettings.html | 4 +- docs/reference/dicoOptimizationSettings.html | 4 +- docs/reference/dot-dailyToWeekly.html | 4 +- docs/reference/dot-hourlyToOther.html | 4 +- docs/reference/edit-cluster.html | 4 +- docs/reference/editArea.html | 4 +- docs/reference/editBindingConstraint.html | 4 +- docs/reference/editLink.html | 4 +- docs/reference/filteringOptions.html | 4 +- docs/reference/getJobLogs.html | 4 +- docs/reference/getJobs.html | 4 +- docs/reference/index.html | 20 +- docs/reference/mockSimulationAPI.html | 4 +- docs/reference/nodalOptimizationOptions.html | 4 +- docs/reference/playlist.html | 4 +- docs/reference/propertiesLinkOptions.html | 4 +- docs/reference/remove-cluster.html | 4 +- docs/reference/removeArea.html | 4 +- docs/reference/removeBindingConstraint.html | 4 +- docs/reference/removeLink.html | 4 +- docs/reference/runSimulation.html | 4 +- docs/reference/runTsGenerator.html | 4 +- docs/reference/scenario-builder.html | 4 +- docs/reference/searchStudy.html | 4 +- docs/reference/setAPImode.html | 4 +- docs/reference/setSolverPath.html | 4 +- docs/reference/updateAdequacySettings.html | 4 +- docs/reference/updateGeneralSettings.html | 4 +- docs/reference/updateInputSettings.html | 4 +- .../reference/updateOptimizationSettings.html | 4 +- docs/reference/updateOutputSettings.html | 4 +- docs/reference/variant-commands.html | 4 +- docs/reference/variant.html | 4 +- docs/reference/write-ini.html | 4 +- docs/reference/writeEconomicOptions.html | 4 +- docs/reference/writeHydroValues.html | 152 +++++++++++++ docs/reference/writeInputTS.html | 4 +- docs/reference/writeMiscGen.html | 4 +- docs/reference/writeOutputValues.html | 4 +- docs/reference/writeSeriesPrepro.html | 4 +- docs/reference/writeWaterValues.html | 4 +- docs/sitemap.xml | 12 + 80 files changed, 888 insertions(+), 189 deletions(-) create mode 100644 .github/workflows/test-coverage.yaml create mode 100644 codecov.yml create mode 100644 docs/reference/copyStudyWeb.html create mode 100644 docs/reference/createClusterBulk.html create mode 100644 docs/reference/deleteStudy.html create mode 100644 docs/reference/writeHydroValues.html diff --git a/.Rbuildignore b/.Rbuildignore index 726d769c..48fe7288 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -9,3 +9,4 @@ test_case/ ^pkgdown$ ^\.github$ man-roxygen/ +^codecov\.yml$ diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml new file mode 100644 index 00000000..2c5bb502 --- /dev/null +++ b/.github/workflows/test-coverage.yaml @@ -0,0 +1,50 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help +on: + push: + branches: [main, master] + pull_request: + branches: [main, master] + +name: test-coverage + +jobs: + test-coverage: + runs-on: ubuntu-latest + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + + steps: + - uses: actions/checkout@v3 + + - uses: r-lib/actions/setup-r@v2 + with: + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::covr + needs: coverage + + - name: Test coverage + run: | + covr::codecov( + quiet = FALSE, + clean = FALSE, + install_path = file.path(Sys.getenv("RUNNER_TEMP"), "package") + ) + shell: Rscript {0} + + - name: Show testthat output + if: always() + run: | + ## -------------------------------------------------------------------- + find ${{ runner.temp }}/package -name 'testthat.Rout*' -exec cat '{}' \; || true + shell: bash + + - name: Upload test results + if: failure() + uses: actions/upload-artifact@v3 + with: + name: coverage-test-failures + path: ${{ runner.temp }}/package diff --git a/README.md b/README.md index 7c7f5bbb..0e32093e 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,13 @@ > Edit an Antares study before running a simulation. -[![Coverage Status](https://img.shields.io/codecov/c/github/rte-antares-rpackage/antaresEditObject/master.svg)](https://codecov.io/github/rte-antares-rpackage/antaresEditObject?branch=master) [![version](http://www.r-pkg.org/badges/version/antaresEditObject)](https://CRAN.R-project.org/package=antaresEditObject) [![cran checks](https://cranchecks.info/badges/worst/antaresEditObject)](https://cranchecks.info/pkgs/antaresEditObject) [![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#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) [![cranlogs](http://cranlogs.r-pkg.org/badges/antaresEditObject)](https://CRAN.R-project.org/package=antaresEditObject) [![R-CMD-check](https://github.com/rte-antares-rpackage/antaresEditObject/workflows/R-CMD-check/badge.svg)](https://github.com/rte-antares-rpackage/antaresEditObject/actions) +[![Codecov test coverage](https://codecov.io/gh/rte-antares-rpackage/antaresEditObject/branch/master/graph/badge.svg)](https://app.codecov.io/gh/rte-antares-rpackage/antaresEditObject?branch=master) diff --git a/codecov.yml b/codecov.yml new file mode 100644 index 00000000..04c55859 --- /dev/null +++ b/codecov.yml @@ -0,0 +1,14 @@ +comment: false + +coverage: + status: + project: + default: + target: auto + threshold: 1% + informational: true + patch: + default: + target: auto + threshold: 1% + informational: true diff --git a/docs/404.html b/docs/404.html index 3543e1a8..502668b1 100644 --- a/docs/404.html +++ b/docs/404.html @@ -32,7 +32,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -109,7 +109,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 76559c54..c64a25a0 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -83,7 +83,7 @@

License

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/articles/antaresEditObject.html b/docs/articles/antaresEditObject.html index 79f8a4e7..a1fcb338 100644 --- a/docs/articles/antaresEditObject.html +++ b/docs/articles/antaresEditObject.html @@ -33,7 +33,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -280,7 +280,7 @@

Run an Antares simulation

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/articles/api-variant-management.html b/docs/articles/api-variant-management.html index e01e0437..e0c4d4ed 100644 --- a/docs/articles/api-variant-management.html +++ b/docs/articles/api-variant-management.html @@ -33,7 +33,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -342,10 +342,6 @@

Create a cluster area = "area01", cluster_name = "clus01" ) -#> Warning in createCluster(area = "area01", cluster_name = "clus01"): Group: -#> 'Other' is not a valid name recognized by Antares, you should be using one of: -#> Gas, Hard coal, Lignite, Mixed fuel, Nuclear, Oil, Other, Other 2, Other 3, -#> Other 4 #> i Command create_cluster registered, see all commands with `getVariantCommands()` getVariantCommands(last = TRUE) #> [ @@ -387,10 +383,6 @@

Create a cluster ncol = 12 ) ) -#> Warning in createCluster(area = "area01", cluster_name = "clus02", unitcount = -#> 1L, : Group: 'Nuclear' is not a valid name recognized by Antares, you should be -#> using one of: Gas, Hard coal, Lignite, Mixed fuel, Nuclear, Oil, Other, Other 2, -#> Other 3, Other 4 #> i Command create_cluster registered, see all commands with `getVariantCommands()` #> i Command replace_matrix registered, see all commands with `getVariantCommands()` getVariantCommands(last = 2) @@ -437,10 +429,6 @@

Create a cluster area = "area02", cluster_name = "clus000" ) -#> Warning in createCluster(area = "area02", cluster_name = "clus000"): Group: -#> 'Other' is not a valid name recognized by Antares, you should be using one of: -#> Gas, Hard coal, Lignite, Mixed fuel, Nuclear, Oil, Other, Other 2, Other 3, -#> Other 4 #> i Command create_cluster registered, see all commands with `getVariantCommands()` removeCluster( area = "area02", @@ -654,7 +642,7 @@

Other 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 17ceec26..9939b304 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -87,7 +87,7 @@

All vignettes

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/articles/renewables-energy-sources.html b/docs/articles/renewables-energy-sources.html index 376606fa..f74a8d2a 100644 --- a/docs/articles/renewables-energy-sources.html +++ b/docs/articles/renewables-energy-sources.html @@ -33,7 +33,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -190,7 +190,7 @@

Scenario builder

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/articles/scenario-builder.html b/docs/articles/scenario-builder.html index 2defddeb..c3ee486c 100644 --- a/docs/articles/scenario-builder.html +++ b/docs/articles/scenario-builder.html @@ -33,7 +33,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -118,33 +118,13 @@

Scenario Builder

# First area createArea("earth") createCluster(area = "earth", cluster_name = "america", add_prefix = FALSE) -#> Warning in createCluster(area = "earth", cluster_name = "america", add_prefix = -#> FALSE): Group: 'Other' is not a valid name recognized by Antares, you should be -#> using one of: Gas, Hard coal, Lignite, Mixed fuel, Nuclear, Oil, Other, Other 2, -#> Other 3, Other 4 createCluster(area = "earth", cluster_name = "africa", add_prefix = FALSE) -#> Warning in createCluster(area = "earth", cluster_name = "africa", add_prefix = -#> FALSE): Group: 'Other' is not a valid name recognized by Antares, you should be -#> using one of: Gas, Hard coal, Lignite, Mixed fuel, Nuclear, Oil, Other, Other 2, -#> Other 3, Other 4 createCluster(area = "earth", cluster_name = "europe", add_prefix = FALSE) -#> Warning in createCluster(area = "earth", cluster_name = "europe", add_prefix = -#> FALSE): Group: 'Other' is not a valid name recognized by Antares, you should be -#> using one of: Gas, Hard coal, Lignite, Mixed fuel, Nuclear, Oil, Other, Other 2, -#> Other 3, Other 4 # Second one createArea("moon") createCluster(area = "moon", cluster_name = "tranquility", add_prefix = FALSE) -#> Warning in createCluster(area = "moon", cluster_name = "tranquility", add_prefix -#> = FALSE): Group: 'Other' is not a valid name recognized by Antares, you should -#> be using one of: Gas, Hard coal, Lignite, Mixed fuel, Nuclear, Oil, Other, Other -#> 2, Other 3, Other 4 createCluster(area = "moon", cluster_name = "serenety", add_prefix = FALSE) -#> Warning in createCluster(area = "moon", cluster_name = "serenety", add_prefix = -#> FALSE): Group: 'Other' is not a valid name recognized by Antares, you should be -#> using one of: Gas, Hard coal, Lignite, Mixed fuel, Nuclear, Oil, Other, Other 2, -#> Other 3, Other 4 # More areas createArea("titan") @@ -265,7 +245,7 @@

Scenario Builder

updateScenarioBuilder( ldata = my_scenario, series = "thermal", - clusters_areas = data.table::data.table( + clusters_areas = data.table::data.table( area = c("earth", "earth"), cluster = c("africa", "europe") ) @@ -318,7 +298,7 @@

Scenario Builder

-

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 f5de7fc7..e479929d 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -122,13 +122,13 @@

Citation

Bachelier V, Breant F, Perrier V (2023). antaresEditObject: Edit an 'Antares' Simulation. -R package version 0.5.0, https://github.com/rte-antares-rpackage/antaresEditObject. +R package version 0.5.1, https://github.com/rte-antares-rpackage/antaresEditObject. 

@Manual{,
   title = {antaresEditObject: Edit an 'Antares' Simulation},
   author = {Veronique Bachelier and Frederic Breant and Victor Perrier},
   year = {2023},
-  note = {R package version 0.5.0},
+  note = {R package version 0.5.1},
   url = {https://github.com/rte-antares-rpackage/antaresEditObject},
 }
@@ -143,7 +143,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 11590671..e16870e9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -35,7 +35,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -103,7 +103,7 @@

Installationinstall.packages("antaresEditObject")

Or install dev version from GitHub:

-remotes::install_github("rte-antares-rpackage/antaresEditObject", build_vignettes = TRUE)
+remotes::install_github("rte-antares-rpackage/antaresEditObject", build_vignettes = TRUE)

Goal @@ -158,13 +158,13 @@

Developers

Dev status

    -
  • Coverage Status
  • version
  • cran checks
  • Lifecycle: stable
  • Project Status: Active – The project has reached a stable, usable state and is being actively developed.
  • cranlogs
  • R-CMD-check
    • +
  • Codecov test coverage
@@ -179,7 +179,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 2e34baef..9637ebae 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1
@@ -66,6 +66,19 @@

Changelog

Source: NEWS.md +
+

antaresEditObject 0.5.1

+

NEW FEATURES :

+

BUGFIXES :

+

antaresEditObject 0.5.0

NEW FEATURES :

@@ -96,11 +109,12 @@

antares

antaresEditObject 0.4.0

New functions

-

  • Antares v840 : new parameter result-format to choose output format (txt/zip) + new values for transmission-capacities parameter.

    • -

  • Antares v832 : added filtering options to bindingConstraints.

    • -

  • Antares v830 : updateAdequacySettings() function to activate Adequacy Patch and set parameters.

    • -

  • Antares v820 : createLink() and editLink() have a new argument tsLink allowing to write transmission capacities time-series.

    • -

  • createBindingConstraintBulk() allow to create multiple binding constraints at once.

    • +
    • Antares v840 : new parameter result-format to choose output format (txt/zip) + new values for transmission-capacities parameter.
      • +
    • Antares v832 : added filtering options to bindingConstraints.
      • +
    • Antares v830 : updateAdequacySettings() function to activate Adequacy Patch and set parameters. + createArea() and editArea() support for new adequacy_patch.ini file.
      • +
    • Antares v820 : createLink() and editLink() have a new argument tsLink allowing to write transmission capacities time-series.
      • +
    • +createBindingConstraintBulk() allow to create multiple binding constraints at once.

Breaking changes

@@ -205,7 +219,7 @@

antares

-

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 61206433..4f83468a 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,10 +1,10 @@ pandoc: 2.11.2 -pkgdown: 2.0.7 +pkgdown: 2.0.6 pkgdown_sha: ~ articles: antaresEditObject: antaresEditObject.html api-variant-management: api-variant-management.html renewables-energy-sources: renewables-energy-sources.html scenario-builder: scenario-builder.html -last_built: 2023-03-10T17:04Z +last_built: 2023-04-06T08:47Z diff --git a/docs/reference/activateRES.html b/docs/reference/activateRES.html index 46f7d78c..0d725d8a 100644 --- a/docs/reference/activateRES.html +++ b/docs/reference/activateRES.html @@ -19,7 +19,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -124,7 +124,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/adequacyOptions.html b/docs/reference/adequacyOptions.html index 13232011..7f212908 100644 --- a/docs/reference/adequacyOptions.html +++ b/docs/reference/adequacyOptions.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.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/antaresRead-reexports.html b/docs/reference/antaresRead-reexports.html index e5256976..d3fc41ba 100644 --- a/docs/reference/antaresRead-reexports.html +++ b/docs/reference/antaresRead-reexports.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -92,7 +92,7 @@

Re-exports from antaresRead

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/backupStudy.html b/docs/reference/backupStudy.html index 3d682866..6ef7da49 100644 --- a/docs/reference/backupStudy.html +++ b/docs/reference/backupStudy.html @@ -1,6 +1,6 @@ Create a backup with an Antares Study — backupStudy • antaresEditObject @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -70,14 +70,15 @@

Create a backup with an Antares Study

Antares API NO

-

Save an Antares Study or only inputs in a .tar.gz file

+

Save an Antares Study or only inputs in a .tar.gz or .zip file

backupStudy(
   backupfile,
-  what = c("input", "study"),
-  opts = antaresRead::simOptions()
+  what = "study",
+  opts = antaresRead::simOptions(),
+  extension = ".zip"
 )
@@ -97,6 +98,10 @@

Arguments

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

+ +
extension
+

Defaut is .zip.

+

Value

@@ -124,7 +129,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/check-version.html b/docs/reference/check-version.html index 363e0540..3c0813c5 100644 --- a/docs/reference/check-version.html +++ b/docs/reference/check-version.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.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/checkRemovedArea.html b/docs/reference/checkRemovedArea.html index 343f9678..197fca4d 100644 --- a/docs/reference/checkRemovedArea.html +++ b/docs/reference/checkRemovedArea.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -116,7 +116,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/cleanUpOutput.html b/docs/reference/cleanUpOutput.html index 8eb83b01..f9d7dfcb 100644 --- a/docs/reference/cleanUpOutput.html +++ b/docs/reference/cleanUpOutput.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -98,7 +98,7 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/computeOtherFromHourlyMulti.html b/docs/reference/computeOtherFromHourlyMulti.html index fc12fe54..dd25019e 100644 --- a/docs/reference/computeOtherFromHourlyMulti.html +++ b/docs/reference/computeOtherFromHourlyMulti.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -139,7 +139,7 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/computeOtherFromHourlyYear.html b/docs/reference/computeOtherFromHourlyYear.html index 54e2d08f..5098bc06 100644 --- a/docs/reference/computeOtherFromHourlyYear.html +++ b/docs/reference/computeOtherFromHourlyYear.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -129,7 +129,7 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/computeTimeStampFromHourly.html b/docs/reference/computeTimeStampFromHourly.html index 897490d3..4d01a585 100644 --- a/docs/reference/computeTimeStampFromHourly.html +++ b/docs/reference/computeTimeStampFromHourly.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.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/convertConfigToAdq.html b/docs/reference/convertConfigToAdq.html index dc2519e9..1a3f2ea4 100644 --- a/docs/reference/convertConfigToAdq.html +++ b/docs/reference/convertConfigToAdq.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -104,7 +104,7 @@

See also

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/copyOutput.html b/docs/reference/copyOutput.html index 0455a5b5..457c3a7e 100644 --- a/docs/reference/copyOutput.html +++ b/docs/reference/copyOutput.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -121,7 +121,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/copyStudyWeb.html b/docs/reference/copyStudyWeb.html new file mode 100644 index 00000000..14ed28de --- /dev/null +++ b/docs/reference/copyStudyWeb.html @@ -0,0 +1,145 @@ + +Import physical study to Antares Web (managed study) — copyStudyWeb • antaresEditObject + + +
+
+ + + +
+
+
+

Import physical study to Antares Web (managed study)

+ Source: R/importStudyAPI.R + +
+ +
+

Copy study from an existing workspace into a managed study. +NOTE : The study must be present in a workspace (DRD, PPSE..) not just locally.

+
+ +
+ 
copyStudyWeb(
+  opts = antaresRead::simOptions(),
+  host,
+  token,
+  outputs = T,
+  groups = NULL,
+  suffix = "managedCopy"
+)
+
+ +
+

Arguments

+
opts
+

List of simulation parameters returned by the function antaresRead::setSimulationPath. +If id is not available, antaresRead::searchStudy will be used to find study.

+ + +
host
+

Host of AntaREST server API.

+ + +
token
+

API personnal access token.

+ + +
outputs
+

Logical. Determine if outputs are copied too.

+ + +
groups
+

Character. Add study to groups of Antares Web.

+ + +
suffix
+

Character. default is "managedCopy" +By default the new study will be : studyname_managedCopy

+ +
+
+

Value

+ + +

New managed study ID

+
+ +
+ +
+ + +
+

Developed by Veronique Bachelier, Frederic Breant, Victor Perrier.

+
+ +
+

Site built with pkgdown 2.0.6.

+
+ +
+ + + + + + + + diff --git a/docs/reference/create-binding-constraint.html b/docs/reference/create-binding-constraint.html index 8a57a7ed..807d9c00 100644 --- a/docs/reference/create-binding-constraint.html +++ b/docs/reference/create-binding-constraint.html @@ -19,7 +19,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -206,7 +206,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/create-cluster.html b/docs/reference/create-cluster.html index 775e359c..fe28ba81 100644 --- a/docs/reference/create-cluster.html +++ b/docs/reference/create-cluster.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -175,7 +175,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/create-study.html b/docs/reference/create-study.html index eae7f45a..632865d3 100644 --- a/docs/reference/create-study.html +++ b/docs/reference/create-study.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -138,7 +138,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/createArea.html b/docs/reference/createArea.html index 62628e03..dfa1e510 100644 --- a/docs/reference/createArea.html +++ b/docs/reference/createArea.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -159,7 +159,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/createClusterBulk.html b/docs/reference/createClusterBulk.html new file mode 100644 index 00000000..7b8afc50 --- /dev/null +++ b/docs/reference/createClusterBulk.html @@ -0,0 +1,214 @@ + +Create serial thermal cluster — createClusterBulk • antaresEditObject + + +
+
+ + + +
+
+
+

Create serial thermal cluster

+ Source: R/createClusterBulk.R + +
+ +
+

For each area, the thermal cluster data are generated :

  • Writing .ini files

    • +

  • Writing time_series files

    • +

  • Writing prepro_data files

    • +

  • Writing prepro_modulation files

    • +
+ +
+ 
createClusterBulk(
+  cluster_object,
+  area_zone,
+  add_prefix = TRUE,
+  opts = antaresRead::simOptions()
+)
+
+ +
+

Arguments

+
cluster_object
+

list mutiple list containing the parameters for writing each cluster

+ + +
area_zone
+

character name of area to create cluster

+ + +
add_prefix
+

logical prefix cluster name with area name

+ + +
opts
+

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

+ +
+
+

Value

+ + +

An updated list containing various information about the simulation.

+ + +

list containing meta information about the simulation

+
+
+

Details

+

see the example to write a cluster object, +see the original function createCluster()

+

Structure of cluster_object :

+

The list must be structured with named items

  • parameter : list of paramaters to write in .ini file

    • +

  • overwrite : logical to choose to overwrite an existing cluster (if not present, set to FALSE)

    • +

  • time_series : matrix or data.frame the "ready-made" 8760-hour time-series

    • +

  • prepro_data : matrix or data.frame Pre-process data

    • +

  • prepro_modulation : matrix or data.frame Pre-process modulation

    • +

Details for sublist cluster_object[["parameter"]] :

  • name : Name for the cluster, +it will prefixed by area name, unless you set add_prefix = FALSE

    • +

  • group : Group of the cluster, depends on cluster type

    • +

  • ... : Parameters to write in the Ini file

    • +
+ +
+

Examples

+ 
if (FALSE) {
+
+# /!\/!\/!\ use or create a study /!\/!\/!\
+
+# data preparation for sutructures
+ts <- matrix(rep(c(0, 8000), each = 24*364), 
+             ncol = 2)
+
+df_pd <- matrix(rep(c(1, 1, 1, 0), each = 24*365), 
+                ncol = 4)
+
+df_pm <- matrix(data = c(rep(1, times = 365 * 24 * 3), rep(0, times = 365 * 24 * 1)), 
+                ncol = 4)
+
+
+# Example cluster object
+zone_test_1 <- list(
+  `CCGT old 1`= list(
+  parameter= list(
+  name= "CCGT old 1",
+  group = "Other",
+  unitcount= 10L,
+  nominalcapacity= 100,
+   enabled= "true",
+   `min-stable-power`= 80L,
+   `min-up-time`= 20L,
+   `min-down_time`= 30L),
+   overwrite= TRUE,
+   time_series = ts_8760,
+   prepro_data = df_pd,
+   prepro_modulation = df_pm))
+ 
+ # overwrite existing cluster
+zone_test_2 <- list(
+ `PEAK`= list(parameter= list(
+   name= "PEAK",
+   group = "Other"),
+   overwrite= TRUE,
+   time_series = ts,
+   prepro_data = df_pd,
+   prepro_modulation = df_pm))
+
+# Create multiple areas with multiple clusters
+list_areas <- antaresRead::getAreas()[1:5]
+
+lapply(list_areas, createClusterBulk,
+cluster_object = c(zone_test_1, zone_test_2),
+add_prefix = TRUE)
+
+}
+
+
+
+
+ +
+ + +
+

Developed by Veronique Bachelier, Frederic Breant, Victor Perrier.

+
+ +
+

Site built with pkgdown 2.0.6.

+
+ +
+ + + + + + + + diff --git a/docs/reference/createDSR.html b/docs/reference/createDSR.html index addf2a66..dc30dc60 100644 --- a/docs/reference/createDSR.html +++ b/docs/reference/createDSR.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -187,7 +187,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/createDistrict.html b/docs/reference/createDistrict.html index 4480053f..ae204018 100644 --- a/docs/reference/createDistrict.html +++ b/docs/reference/createDistrict.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -155,7 +155,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/createLink.html b/docs/reference/createLink.html index 3dab5950..bac95a1b 100644 --- a/docs/reference/createLink.html +++ b/docs/reference/createLink.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -176,7 +176,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/createPSP.html b/docs/reference/createPSP.html index 382a881d..397eddb4 100644 --- a/docs/reference/createPSP.html +++ b/docs/reference/createPSP.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -203,7 +203,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/deleteStudy.html b/docs/reference/deleteStudy.html new file mode 100644 index 00000000..01f33ed0 --- /dev/null +++ b/docs/reference/deleteStudy.html @@ -0,0 +1,108 @@ + +Delete a study — deleteStudy • antaresEditObject + + +
+
+ + + +
+
+
+

Delete a study

+ Source: R/createStudy.R + +
+ +
+

Delete a study

+
+ +
+ 
deleteStudy(opts = simOptions())
+
+ +
+

Arguments

+
opts
+

List. study options

+ +
+ +
+ +
+ + +
+

Developed by Veronique Bachelier, Frederic Breant, Victor Perrier.

+
+ +
+

Site built with pkgdown 2.0.6.

+
+ +
+ + + + + + + + diff --git a/docs/reference/dicoGeneralSettings.html b/docs/reference/dicoGeneralSettings.html index 64aa36ed..e0474615 100644 --- a/docs/reference/dicoGeneralSettings.html +++ b/docs/reference/dicoGeneralSettings.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -106,7 +106,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/dicoOptimizationSettings.html b/docs/reference/dicoOptimizationSettings.html index 8ebec910..d6741d57 100644 --- a/docs/reference/dicoOptimizationSettings.html +++ b/docs/reference/dicoOptimizationSettings.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -106,7 +106,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/dot-dailyToWeekly.html b/docs/reference/dot-dailyToWeekly.html index 4f17dc54..f7f58a7c 100644 --- a/docs/reference/dot-dailyToWeekly.html +++ b/docs/reference/dot-dailyToWeekly.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -102,7 +102,7 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/dot-hourlyToOther.html b/docs/reference/dot-hourlyToOther.html index 76f47d88..2bf91140 100644 --- a/docs/reference/dot-hourlyToOther.html +++ b/docs/reference/dot-hourlyToOther.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -102,7 +102,7 @@

Arguments

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/edit-cluster.html b/docs/reference/edit-cluster.html index bdb05af4..bddecccb 100644 --- a/docs/reference/edit-cluster.html +++ b/docs/reference/edit-cluster.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -171,7 +171,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/editArea.html b/docs/reference/editArea.html index a8f89318..b837ae5b 100644 --- a/docs/reference/editArea.html +++ b/docs/reference/editArea.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -162,7 +162,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/editBindingConstraint.html b/docs/reference/editBindingConstraint.html index 293b71ee..abc5224b 100644 --- a/docs/reference/editBindingConstraint.html +++ b/docs/reference/editBindingConstraint.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -169,7 +169,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/editLink.html b/docs/reference/editLink.html index f91f7b4c..2d04e9d3 100644 --- a/docs/reference/editLink.html +++ b/docs/reference/editLink.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -175,7 +175,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/filteringOptions.html b/docs/reference/filteringOptions.html index d81ead22..e0b2aa4d 100644 --- a/docs/reference/filteringOptions.html +++ b/docs/reference/filteringOptions.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -118,7 +118,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/getJobLogs.html b/docs/reference/getJobLogs.html index 712dbeeb..1a03d75e 100644 --- a/docs/reference/getJobLogs.html +++ b/docs/reference/getJobLogs.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -121,7 +121,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/getJobs.html b/docs/reference/getJobs.html index 60eceedf..5c7ae440 100644 --- a/docs/reference/getJobs.html +++ b/docs/reference/getJobs.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -114,7 +114,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 d3da3356..b293f54a 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -113,6 +113,10 @@

All functions copyOutput()

Copy of the output files of an Antares study

+ +

copyStudyWeb()

+ +

Import physical study to Antares Web (managed study)

createBindingConstraint() createBindingConstraintBulk()

@@ -129,6 +133,10 @@

All functions createArea()

Create an area in an Antares study

+ +

createClusterBulk()

+ +

Create serial thermal cluster

createDistrict()

@@ -145,6 +153,10 @@

All functions createPSP() getCapacityPSP() editPSP()

Create a Pumped Storage Power plant (PSP)

+ +

deleteStudy()

+ +

Delete a study

dicoGeneralSettings()

@@ -274,6 +286,10 @@

All functions writeEconomicOptions()

Write Economic Options

+ +

writeHydroValues()

+ +

Write Hydro Values

writeInputTS()

@@ -307,7 +323,7 @@

All functions
-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/mockSimulationAPI.html b/docs/reference/mockSimulationAPI.html index 1f98d04c..60af91e7 100644 --- a/docs/reference/mockSimulationAPI.html +++ b/docs/reference/mockSimulationAPI.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -119,7 +119,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/nodalOptimizationOptions.html b/docs/reference/nodalOptimizationOptions.html index ee7d2f68..0ddf5763 100644 --- a/docs/reference/nodalOptimizationOptions.html +++ b/docs/reference/nodalOptimizationOptions.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -158,7 +158,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/playlist.html b/docs/reference/playlist.html index 9fee627c..c3451777 100644 --- a/docs/reference/playlist.html +++ b/docs/reference/playlist.html @@ -23,7 +23,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -147,7 +147,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/propertiesLinkOptions.html b/docs/reference/propertiesLinkOptions.html index 9aa27e7b..f3927493 100644 --- a/docs/reference/propertiesLinkOptions.html +++ b/docs/reference/propertiesLinkOptions.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -155,7 +155,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/remove-cluster.html b/docs/reference/remove-cluster.html index 69745e28..7dd0266e 100644 --- a/docs/reference/remove-cluster.html +++ b/docs/reference/remove-cluster.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -146,7 +146,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/removeArea.html b/docs/reference/removeArea.html index 0e4bd0d3..c0f1a28c 100644 --- a/docs/reference/removeArea.html +++ b/docs/reference/removeArea.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -118,7 +118,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/removeBindingConstraint.html b/docs/reference/removeBindingConstraint.html index 0780113c..3acace8f 100644 --- a/docs/reference/removeBindingConstraint.html +++ b/docs/reference/removeBindingConstraint.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -118,7 +118,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/removeLink.html b/docs/reference/removeLink.html index 368f098b..85b71408 100644 --- a/docs/reference/removeLink.html +++ b/docs/reference/removeLink.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.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/runSimulation.html b/docs/reference/runSimulation.html index 0d8fc8f7..9b72a6f7 100644 --- a/docs/reference/runSimulation.html +++ b/docs/reference/runSimulation.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -148,7 +148,7 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/runTsGenerator.html b/docs/reference/runTsGenerator.html index 778b2f0c..901f899e 100644 --- a/docs/reference/runTsGenerator.html +++ b/docs/reference/runTsGenerator.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -128,7 +128,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/scenario-builder.html b/docs/reference/scenario-builder.html index 1089200e..bec33a2d 100644 --- a/docs/reference/scenario-builder.html +++ b/docs/reference/scenario-builder.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -239,7 +239,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/searchStudy.html b/docs/reference/searchStudy.html index 898c7a1f..d59b81b8 100644 --- a/docs/reference/searchStudy.html +++ b/docs/reference/searchStudy.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -136,7 +136,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/setAPImode.html b/docs/reference/setAPImode.html index d767cf16..56582274 100644 --- a/docs/reference/setAPImode.html +++ b/docs/reference/setAPImode.html @@ -21,7 +21,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -122,7 +122,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/setSolverPath.html b/docs/reference/setSolverPath.html index 2c01b45e..b472ade6 100644 --- a/docs/reference/setSolverPath.html +++ b/docs/reference/setSolverPath.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -106,7 +106,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/updateAdequacySettings.html b/docs/reference/updateAdequacySettings.html index da313e88..bdd6a31b 100644 --- a/docs/reference/updateAdequacySettings.html +++ b/docs/reference/updateAdequacySettings.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -164,7 +164,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/updateGeneralSettings.html b/docs/reference/updateGeneralSettings.html index 6c727bd0..a7331b22 100644 --- a/docs/reference/updateGeneralSettings.html +++ b/docs/reference/updateGeneralSettings.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -272,7 +272,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/updateInputSettings.html b/docs/reference/updateInputSettings.html index 2dd954e0..eeb1eac3 100644 --- a/docs/reference/updateInputSettings.html +++ b/docs/reference/updateInputSettings.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -117,7 +117,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/updateOptimizationSettings.html b/docs/reference/updateOptimizationSettings.html index aa128edd..4c595b8d 100644 --- a/docs/reference/updateOptimizationSettings.html +++ b/docs/reference/updateOptimizationSettings.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -208,7 +208,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/updateOutputSettings.html b/docs/reference/updateOutputSettings.html index 6a3b8ced..66bb854a 100644 --- a/docs/reference/updateOutputSettings.html +++ b/docs/reference/updateOutputSettings.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -131,7 +131,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/variant-commands.html b/docs/reference/variant-commands.html index 73b49d8a..b482b369 100644 --- a/docs/reference/variant-commands.html +++ b/docs/reference/variant-commands.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -130,7 +130,7 @@

Value

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/variant.html b/docs/reference/variant.html index 47ec45ee..48f485d2 100644 --- a/docs/reference/variant.html +++ b/docs/reference/variant.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -119,7 +119,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/write-ini.html b/docs/reference/write-ini.html index a2c7f9e6..2dfdf899 100644 --- a/docs/reference/write-ini.html +++ b/docs/reference/write-ini.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -136,7 +136,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/writeEconomicOptions.html b/docs/reference/writeEconomicOptions.html index 35d82f03..ae4510fd 100644 --- a/docs/reference/writeEconomicOptions.html +++ b/docs/reference/writeEconomicOptions.html @@ -19,7 +19,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -130,7 +130,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/writeHydroValues.html b/docs/reference/writeHydroValues.html new file mode 100644 index 00000000..8820ff19 --- /dev/null +++ b/docs/reference/writeHydroValues.html @@ -0,0 +1,152 @@ + +Write Hydro Values — writeHydroValues • antaresEditObject + + +
+
+ + + +
+
+
+

Write Hydro Values

+ Source: R/writeHydroValues.R + +
+ +
+

Antares API OK

+

Write waterValues, reservoirLevels, maxpower, inflowPattern and creditModulations data for a given area.

+
+ +
+ 
writeHydroValues(
+  area,
+  type,
+  data = NULL,
+  overwrite = TRUE,
+  opts = antaresRead::simOptions()
+)
+
+ +
+

Arguments

+
area
+

The area where to add the values.

+ + +
type
+

Type of hydro file, it can be "waterValues", "reservoir", "maxpower", "inflowPattern" or "creditmodulations".

+ + +
data
+

The data must have specific dimension depending on the type of file :

  • waterValues: a 365x101 numeric matrix: +marginal values for the stored energy based on date (365 days) +and on the reservoir level (101 round percentage values ranging from +0% to 100%). OR a 3-column matrix with 365x101 rows. In this latter case the 3 columns must +be 'date', 'level' and 'value' (in this order), and the rows must be sorted by: +ascending day, ascending level.

    • +

  • reservoir: a 365x3 numeric matrix. The columns contains respectively the levels min, avg and max.

    • +

  • maxpower: a 365x4 numeric matrix.

    • +

  • inflowPattern: a 365x1 numeric matrix.

    • +

  • creditmodulations: a 2x101 numeric matrix.

    • +
+ + +
overwrite
+

Logical. Overwrite the values if a file already exists.

+ + +
opts
+

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

+ +
+ +
+

Examples

+ 
if (FALSE) {
+
+writeHydroValues("fictive_area", type = "inflowPattern", data = matrix(rep(0, 365*1), nrow = 365))
+
+}
+
+
+
+ +
+ + +
+

Developed by Veronique Bachelier, Frederic Breant, Victor Perrier.

+
+ +
+

Site built with pkgdown 2.0.6.

+
+ +
+ + + + + + + + diff --git a/docs/reference/writeInputTS.html b/docs/reference/writeInputTS.html index 2ea08447..78396f4a 100644 --- a/docs/reference/writeInputTS.html +++ b/docs/reference/writeInputTS.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -155,7 +155,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/writeMiscGen.html b/docs/reference/writeMiscGen.html index 6ee42ddc..85e2af56 100644 --- a/docs/reference/writeMiscGen.html +++ b/docs/reference/writeMiscGen.html @@ -17,7 +17,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -118,7 +118,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/writeOutputValues.html b/docs/reference/writeOutputValues.html index 0b7a6fbf..87731eb4 100644 --- a/docs/reference/writeOutputValues.html +++ b/docs/reference/writeOutputValues.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.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/writeSeriesPrepro.html b/docs/reference/writeSeriesPrepro.html index 385ddc31..237199e8 100644 --- a/docs/reference/writeSeriesPrepro.html +++ b/docs/reference/writeSeriesPrepro.html @@ -19,7 +19,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -154,7 +154,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.6.

diff --git a/docs/reference/writeWaterValues.html b/docs/reference/writeWaterValues.html index a2904c03..fa7ada11 100644 --- a/docs/reference/writeWaterValues.html +++ b/docs/reference/writeWaterValues.html @@ -18,7 +18,7 @@ antaresEditObject - 0.5.0 + 0.5.1 @@ -127,7 +127,7 @@

Examples

-

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 1c9e98b4..4da33760 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -66,6 +66,9 @@ /reference/copyOutput.html + + /reference/copyStudyWeb.html + /reference/create-binding-constraint.html @@ -84,6 +87,9 @@ /reference/createCluster.html + + /reference/createClusterBulk.html + /reference/createDistrict.html @@ -99,6 +105,9 @@ /reference/createStudy.html + + /reference/deleteStudy.html + /reference/dicoGeneralSettings.html @@ -225,6 +234,9 @@ /reference/writeEconomicOptions.html + + /reference/writeHydroValues.html + /reference/writeIni.html