diff --git a/404.html b/404.html index 0a7973a2..5fecaf20 100644 --- a/404.html +++ b/404.html @@ -4,95 +4,114 @@ - + Page not found (404) • antaresRead - - - + + + - + + - - Skip to contents + -
-
-
-

Page not found (404)

+ +
+ + + +
+
+
+

Page not found (404)

Content not found. Please use links in the navbar. -
+
+ + +
- + diff --git a/LICENSE-text.html b/LICENSE-text.html index 30bc11ca..6b41ed4b 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -1,76 +1,90 @@ -License • antaresReadLicense • antaresRead - Skip to contents + -
-
-
-

License

+ +
+
+
+

License

COPYRIGHT HOLDER: RTE Réseau de transport d’électricité
-
+
+ - + diff --git a/articles/antaresH5.html b/articles/antaresH5.html index 77f0663d..b3b39c20 100644 --- a/articles/antaresH5.html +++ b/articles/antaresH5.html @@ -4,84 +4,92 @@ - - + Use h5 file format with 'antaresRead' • antaresRead - - - + + + - + + - - Skip to contents + -
- - + +
+ + -
-
-

Use h5 file format with 'antaresRead'

+
+
+
+

Use h5 file format with ‘antaresRead’

Titouan Robert

-

2024-01-31

+

2024-02-01

Source: vignettes/antaresH5.Rmd -
antaresH5.Rmd
+ +
@@ -218,27 +226,34 @@

Use h5 opts for vizualisationopts2 <- setSimulationPath("mySim2.h5") plot(list(opts, opts2))

-
+
+ + + - + diff --git a/articles/antaresRead.html b/articles/antaresRead.html index f78c846f..1b13eb75 100644 --- a/articles/antaresRead.html +++ b/articles/antaresRead.html @@ -4,84 +4,92 @@ - - + The 'antaresRead' Package • antaresRead - - - + + + - + + - - Skip to contents + -
- - + +
+ + -
-
-

The 'antaresRead' Package

+
+
+
+

The ‘antaresRead’ Package

François Guillem

-

2024-01-31

+

2024-02-01

Source: vignettes/antaresRead.Rmd -
antaresRead.Rmd
+ +
@@ -255,27 +263,34 @@

Other useful functions
 help(package = "antaresRead")

-
+
+ + + - + diff --git a/articles/index.html b/articles/index.html index 4c782e09..8339b176 100644 --- a/articles/index.html +++ b/articles/index.html @@ -1,55 +1,62 @@ -Articles • antaresReadArticles • antaresRead - Skip to contents + -
-
-
-

Articles

+ + +
+
+
+

Articles

@@ -61,21 +68,23 @@

All vignettes

The 'antaresRead' Package
-
+
+ - + diff --git a/authors.html b/authors.html index 24d2ec22..ae5308c0 100644 --- a/authors.html +++ b/authors.html @@ -1,59 +1,65 @@ -Authors and Citation • antaresReadAuthors and Citation • antaresRead - Skip to contents + -
-
-
-

Authors and Citation

-
+ + +
+
+
+
+

Authors

+
-
-

Authors

  • Tatiana Vargas. Author, maintainer. @@ -100,39 +106,45 @@

    Authors

+
+
+

Citation

+ Source: DESCRIPTION +
+
-
-

Citation

-

Source: DESCRIPTION

-

Vargas T, ZAWAM J, Guillem F, Thieurmel B, Robert T (2024). +

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.0, https://rte-antares-rpackage.github.io/antaresRead/, https://github.com/rte-antares-rpackage/antaresRead.

- 
@Manual{,
+    
@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.0, https://rte-antares-rpackage.github.io/antaresRead/},
   url = {https://github.com/rte-antares-rpackage/antaresRead},
 }

-
-
+
+ + - + diff --git a/bootstrap-toc.css b/bootstrap-toc.css new file mode 100644 index 00000000..5a859415 --- /dev/null +++ b/bootstrap-toc.css @@ -0,0 +1,60 @@ +/*! + * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/) + * Copyright 2015 Aidan Feldman + * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */ + +/* modified from https://github.com/twbs/bootstrap/blob/94b4076dd2efba9af71f0b18d4ee4b163aa9e0dd/docs/assets/css/src/docs.css#L548-L601 */ + +/* All levels of nav */ +nav[data-toggle='toc'] .nav > li > a { + display: block; + padding: 4px 20px; + font-size: 13px; + font-weight: 500; + color: #767676; +} +nav[data-toggle='toc'] .nav > li > a:hover, +nav[data-toggle='toc'] .nav > li > a:focus { + padding-left: 19px; + color: #563d7c; + text-decoration: none; + background-color: transparent; + border-left: 1px solid #563d7c; +} +nav[data-toggle='toc'] .nav > .active > a, +nav[data-toggle='toc'] .nav > .active:hover > a, +nav[data-toggle='toc'] .nav > .active:focus > a { + padding-left: 18px; + font-weight: bold; + color: #563d7c; + background-color: transparent; + border-left: 2px solid #563d7c; +} + +/* Nav: second level (shown on .active) */ +nav[data-toggle='toc'] .nav .nav { + display: none; /* Hide by default, but at >768px, show it */ + padding-bottom: 10px; +} +nav[data-toggle='toc'] .nav .nav > li > a { + padding-top: 1px; + padding-bottom: 1px; + padding-left: 30px; + font-size: 12px; + font-weight: normal; +} +nav[data-toggle='toc'] .nav .nav > li > a:hover, +nav[data-toggle='toc'] .nav .nav > li > a:focus { + padding-left: 29px; +} +nav[data-toggle='toc'] .nav .nav > .active > a, +nav[data-toggle='toc'] .nav .nav > .active:hover > a, +nav[data-toggle='toc'] .nav .nav > .active:focus > a { + padding-left: 28px; + font-weight: 500; +} + +/* from https://github.com/twbs/bootstrap/blob/e38f066d8c203c3e032da0ff23cd2d6098ee2dd6/docs/assets/css/src/docs.css#L631-L634 */ +nav[data-toggle='toc'] .nav > .active > ul { + display: block; +} diff --git a/bootstrap-toc.js b/bootstrap-toc.js new file mode 100644 index 00000000..1cdd573b --- /dev/null +++ b/bootstrap-toc.js @@ -0,0 +1,159 @@ +/*! + * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/) + * Copyright 2015 Aidan Feldman + * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */ +(function() { + 'use strict'; + + window.Toc = { + helpers: { + // return all matching elements in the set, or their descendants + findOrFilter: function($el, selector) { + // http://danielnouri.org/notes/2011/03/14/a-jquery-find-that-also-finds-the-root-element/ + // http://stackoverflow.com/a/12731439/358804 + var $descendants = $el.find(selector); + return $el.filter(selector).add($descendants).filter(':not([data-toc-skip])'); + }, + + generateUniqueIdBase: function(el) { + var text = $(el).text(); + var anchor = text.trim().toLowerCase().replace(/[^A-Za-z0-9]+/g, '-'); + return anchor || el.tagName.toLowerCase(); + }, + + generateUniqueId: function(el) { + var anchorBase = this.generateUniqueIdBase(el); + for (var i = 0; ; i++) { + var anchor = anchorBase; + if (i > 0) { + // add suffix + anchor += '-' + i; + } + // check if ID already exists + if (!document.getElementById(anchor)) { + return anchor; + } + } + }, + + generateAnchor: function(el) { + if (el.id) { + return el.id; + } else { + var anchor = this.generateUniqueId(el); + el.id = anchor; + return anchor; + } + }, + + createNavList: function() { + return $(''); + }, + + createChildNavList: function($parent) { + var $childList = this.createNavList(); + $parent.append($childList); + return $childList; + }, + + generateNavEl: function(anchor, text) { + var $a = $(''); + $a.attr('href', '#' + anchor); + $a.text(text); + var $li = $('
  • '); + $li.append($a); + return $li; + }, + + generateNavItem: function(headingEl) { + var anchor = this.generateAnchor(headingEl); + var $heading = $(headingEl); + var text = $heading.data('toc-text') || $heading.text(); + return this.generateNavEl(anchor, text); + }, + + // Find the first heading level (`

    `, then `

    `, etc.) that has more than one element. Defaults to 1 (for `

    `). + getTopLevel: function($scope) { + for (var i = 1; i <= 6; i++) { + var $headings = this.findOrFilter($scope, 'h' + i); + if ($headings.length > 1) { + return i; + } + } + + return 1; + }, + + // returns the elements for the top level, and the next below it + getHeadings: function($scope, topLevel) { + var topSelector = 'h' + topLevel; + + var secondaryLevel = topLevel + 1; + var secondarySelector = 'h' + secondaryLevel; + + return this.findOrFilter($scope, topSelector + ',' + secondarySelector); + }, + + getNavLevel: function(el) { + return parseInt(el.tagName.charAt(1), 10); + }, + + populateNav: function($topContext, topLevel, $headings) { + var $context = $topContext; + var $prevNav; + + var helpers = this; + $headings.each(function(i, el) { + var $newNav = helpers.generateNavItem(el); + var navLevel = helpers.getNavLevel(el); + + // determine the proper $context + if (navLevel === topLevel) { + // use top level + $context = $topContext; + } else if ($prevNav && $context === $topContext) { + // create a new level of the tree and switch to it + $context = helpers.createChildNavList($prevNav); + } // else use the current $context + + $context.append($newNav); + + $prevNav = $newNav; + }); + }, + + parseOps: function(arg) { + var opts; + if (arg.jquery) { + opts = { + $nav: arg + }; + } else { + opts = arg; + } + opts.$scope = opts.$scope || $(document.body); + return opts; + } + }, + + // accepts a jQuery object, or an options object + init: function(opts) { + opts = this.helpers.parseOps(opts); + + // ensure that the data attribute is in place for styling + opts.$nav.attr('data-toggle', 'toc'); + + var $topContext = this.helpers.createChildNavList(opts.$nav); + var topLevel = this.helpers.getTopLevel(opts.$scope); + var $headings = this.helpers.getHeadings(opts.$scope, topLevel); + this.helpers.populateNav($topContext, topLevel, $headings); + } + }; + + $(function() { + $('nav[data-toggle="toc"]').each(function(i, el) { + var $nav = $(el); + Toc.init($nav); + }); + }); +})(); diff --git a/docsearch.css b/docsearch.css new file mode 100644 index 00000000..e5f1fe1d --- /dev/null +++ b/docsearch.css @@ -0,0 +1,148 @@ +/* Docsearch -------------------------------------------------------------- */ +/* + Source: https://github.com/algolia/docsearch/ + License: MIT +*/ + +.algolia-autocomplete { + display: block; + -webkit-box-flex: 1; + -ms-flex: 1; + flex: 1 +} + +.algolia-autocomplete .ds-dropdown-menu { + width: 100%; + min-width: none; + max-width: none; + padding: .75rem 0; + background-color: #fff; + background-clip: padding-box; + border: 1px solid rgba(0, 0, 0, .1); + box-shadow: 0 .5rem 1rem rgba(0, 0, 0, .175); +} + +@media (min-width:768px) { + .algolia-autocomplete .ds-dropdown-menu { + width: 175% + } +} + +.algolia-autocomplete .ds-dropdown-menu::before { + display: none +} + +.algolia-autocomplete .ds-dropdown-menu [class^=ds-dataset-] { + padding: 0; + background-color: rgb(255,255,255); + border: 0; + max-height: 80vh; +} + +.algolia-autocomplete .ds-dropdown-menu .ds-suggestions { + margin-top: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion { + padding: 0; + overflow: visible +} + +.algolia-autocomplete .algolia-docsearch-suggestion--category-header { + padding: .125rem 1rem; + margin-top: 0; + font-size: 1.3em; + font-weight: 500; + color: #00008B; + border-bottom: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--wrapper { + float: none; + padding-top: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column { + float: none; + width: auto; + padding: 0; + text-align: left +} + +.algolia-autocomplete .algolia-docsearch-suggestion--content { + float: none; + width: auto; + padding: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--content::before { + display: none +} + +.algolia-autocomplete .ds-suggestion:not(:first-child) .algolia-docsearch-suggestion--category-header { + padding-top: .75rem; + margin-top: .75rem; + border-top: 1px solid rgba(0, 0, 0, .1) +} + +.algolia-autocomplete .ds-suggestion .algolia-docsearch-suggestion--subcategory-column { + display: block; + padding: .1rem 1rem; + margin-bottom: 0.1; + font-size: 1.0em; + font-weight: 400 + /* display: none */ +} + +.algolia-autocomplete .algolia-docsearch-suggestion--title { + display: block; + padding: .25rem 1rem; + margin-bottom: 0; + font-size: 0.9em; + font-weight: 400 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--text { + padding: 0 1rem .5rem; + margin-top: -.25rem; + font-size: 0.8em; + font-weight: 400; + line-height: 1.25 +} + +.algolia-autocomplete .algolia-docsearch-footer { + width: 110px; + height: 20px; + z-index: 3; + margin-top: 10.66667px; + float: right; + font-size: 0; + line-height: 0; +} + +.algolia-autocomplete .algolia-docsearch-footer--logo { + background-image: url("data:image/svg+xml;utf8,"); + background-repeat: no-repeat; + background-position: 50%; + background-size: 100%; + overflow: hidden; + text-indent: -9000px; + width: 100%; + height: 100%; + display: block; + transform: translate(-8px); +} + +.algolia-autocomplete .algolia-docsearch-suggestion--highlight { + color: #FF8C00; + background: rgba(232, 189, 54, 0.1) +} + + +.algolia-autocomplete .algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight { + box-shadow: inset 0 -2px 0 0 rgba(105, 105, 105, .5) +} + +.algolia-autocomplete .ds-suggestion.ds-cursor .algolia-docsearch-suggestion--content { + background-color: rgba(192, 192, 192, .15) +} diff --git a/docsearch.js b/docsearch.js new file mode 100644 index 00000000..b35504cd --- /dev/null +++ b/docsearch.js @@ -0,0 +1,85 @@ +$(function() { + + // register a handler to move the focus to the search bar + // upon pressing shift + "/" (i.e. "?") + $(document).on('keydown', function(e) { + if (e.shiftKey && e.keyCode == 191) { + e.preventDefault(); + $("#search-input").focus(); + } + }); + + $(document).ready(function() { + // do keyword highlighting + /* modified from https://jsfiddle.net/julmot/bL6bb5oo/ */ + var mark = function() { + + var referrer = document.URL ; + var paramKey = "q" ; + + if (referrer.indexOf("?") !== -1) { + var qs = referrer.substr(referrer.indexOf('?') + 1); + var qs_noanchor = qs.split('#')[0]; + var qsa = qs_noanchor.split('&'); + var keyword = ""; + + for (var i = 0; i < qsa.length; i++) { + var currentParam = qsa[i].split('='); + + if (currentParam.length !== 2) { + continue; + } + + if (currentParam[0] == paramKey) { + keyword = decodeURIComponent(currentParam[1].replace(/\+/g, "%20")); + } + } + + if (keyword !== "") { + $(".contents").unmark({ + done: function() { + $(".contents").mark(keyword); + } + }); + } + } + }; + + mark(); + }); +}); + +/* Search term highlighting ------------------------------*/ + +function matchedWords(hit) { + var words = []; + + var hierarchy = hit._highlightResult.hierarchy; + // loop to fetch from lvl0, lvl1, etc. + for (var idx in hierarchy) { + words = words.concat(hierarchy[idx].matchedWords); + } + + var content = hit._highlightResult.content; + if (content) { + words = words.concat(content.matchedWords); + } + + // return unique words + var words_uniq = [...new Set(words)]; + return words_uniq; +} + +function updateHitURL(hit) { + + var words = matchedWords(hit); + var url = ""; + + if (hit.anchor) { + url = hit.url_without_anchor + '?q=' + escape(words.join(" ")) + '#' + hit.anchor; + } else { + url = hit.url + '?q=' + escape(words.join(" ")); + } + + return url; +} diff --git a/index.html b/index.html index 1df8c3d0..c8a7e4f2 100644 --- a/index.html +++ b/index.html @@ -4,16 +4,14 @@ - - + Import, Manipulate and Explore the Results of an Antares Simulation • antaresRead - - - + + + - + + @@ -22,58 +20,70 @@ - - Skip to contents + -
    -
    -


    + +
    + + + + +
    +
    + +


    antaresRead

    @@ -208,7 +218,10 @@

    License Information:
    +
    + +

    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/news/index.html b/news/index.html index 6428abc1..67733aec 100644 --- a/news/index.html +++ b/news/index.html @@ -1,60 +1,67 @@ -Changelog • antaresReadChangelog • antaresRead - Skip to contents + -
    -
    -
    -

    Changelog

    + + +
    +
    +
    +

    Changelog

    Source: NEWS.md
    -

    antaresRead 2.7.0

    +

    antaresRead 2.7.0

    Breaking changes (Antares v8.7) :

    • @@ -67,7 +74,7 @@

      Breaking changes (Antares v8.7) :

    -

    antaresRead 2.6.1 (devlopment)

    +

    antaresRead 2.6.1 (devlopment)

    BUGFIXES :

    -

    antaresRead 2.6.0

    CRAN release: 2023-08-30

    +

    antaresRead 2.6.02023-08-30

    NEW FEATURES (Antares v8.6, cf. Antares v8.6 changelog) :

    • readClusterSTDesc() read “short-term storage” clusters parameters (input files of an antares study)
      • @@ -105,7 +112,7 @@

      antaresRead 2

    -

    antaresRead 2.5.1

    CRAN release: 2023-04-06

    +

    antaresRead 2.5.12023-04-06

    BUGFIXES:

    DEV:

    @@ -113,7 +120,7 @@

    antaresRead 2
  • Package no longer tested on study v6.

    • -

    antaresRead 2.5.0

    CRAN release: 2023-03-13

    +

    antaresRead 2.5.02023-03-13

    NEW FEATURES:

    • Full support of studies up to v8.5
    • Function readAntares() has new argument for binding constraints output (v8.4+) (#173)
      • @@ -130,7 +137,7 @@

      antaresRead 2
    • Fixed copy of original links in mc-all aggregation

    -

    antaresRead 2.4.2

    CRAN release: 2023-02-14

    +

    antaresRead 2.4.22023-02-14

    NEW FEATURES:

    • New function getGeographicTrimming() returns filtering options for selected areas (links optional).
    • New function readInputRes() for reading renewable clusters input data
      • @@ -138,36 +145,36 @@

      antaresRead 2
    • Existing function readInputThermal() : added new argument for thermalData

    -

    antaresRead 2.4.1

    +

    antaresRead 2.4.1

    NEW FEATURES:

    Added new functions readInputThermal() and readAntaresClusters() : Both functions take a vector of clusters instead of areas * readInputThermal() : read thermal TS (availabilities) and modulation in Input mode * readAntaresClusters() : read output data for clusters only with thematic trimming

    -

    antaresRead 2.4.0

    +

    antaresRead 2.4.0

    NEW FEATURES:

    Major upgrade to aggregateResult() and parAggregateMCall() : * Faster & memory efficient * Support for Antares studies up to v8.3 (v8.4 experimental) * Dynamic timestep detection * Creation of grid folder * Recycling of original mc-all data

    -

    antaresRead 2.3.2

    +

    antaresRead 2.3.2

    NEW FEATURES:

    added “profit by cluster” when reading cluster data.

    BUGFIXES:

    Fix for 404 error when some output is missing in API mode(#188).

    -

    antaresRead 2.3.1

    CRAN release: 2022-11-30

    +

    antaresRead 2.3.12022-11-30

    BUGFIXES:

    • readAntares : fix memory problems for linkCapacity = TRUE (>v8.2)
    • Support for url with special characters (#181)
    • Fix for setSimulationPathAPI not working with EnR aggregated (<v8.1) (#180)
    -

    antaresRead 2.3.0

    CRAN release: 2022-10-10

    +

    antaresRead 2.3.02022-10-10

    -

    antaresRead 2.2.97

    +

    antaresRead 2.2.97

    FEATURES:

    • NTC by monte carlo years, antares 8.2 update
      • Update readInputTS when linkCapacity argument is used
        • @@ -175,18 +182,18 @@

        antaresRead

    -

    antaresRead 2.2.96

    +

    antaresRead 2.2.96

    BUGFIXES:

    • #168 : clean memory parAggregateMCall
    -

    antaresRead 2.2.95

    CRAN release: 2022-03-01

    +

    antaresRead 2.2.952022-03-01

    BUGFIXES:

    • removeVirtualAreas : setting custom prodVars same as new storageVars
    • API : fix study checking + httr options
    -

    antaresRead 2.2.9

    CRAN release: 2021-11-06

    +

    antaresRead 2.2.92021-11-06

    FEATURES:

    • Add ENR Cluster support (V8.1)
    • removeVirtualAreas : Can pass storageFlexibility named list
      • @@ -196,12 +203,12 @@

      antaresRead 2
      • aggregateResult parallel export (#161)

    -

    antaresRead 2.2.8

    CRAN release: 2021-06-22

    +

    antaresRead 2.2.82021-06-22

    FEATURES:

    • Fixed bugs in readAntares when file is missing
    -

    antaresRead 2.2.7

    CRAN release: 2021-06-08

    +

    antaresRead 2.2.72021-06-08

    FEATURES:

    • Fixed bugs in readInputTS() for hydroStorage
      • @@ -210,35 +217,35 @@

      antaresRead 2
    • First antares api support

    -

    antaresRead 2.2.5

    CRAN release: 2020-03-18

    +

    antaresRead 2.2.52020-03-18

    FEATURES:

    -

    antaresRead 2.2.4 (2019-02-13)

    CRAN release: 2019-07-18

    +

    antaresRead 2.2.4 (2019-02-13)2019-07-18

    FEATURES:

    • Compatibility with Antares v7
    -

    antaresRead 2.2.3 (2019-02-13)

    CRAN release: 2019-02-13

    +

    antaresRead 2.2.3 (2019-02-13)2019-02-13

    BUGFIXES:

    • Error with next data.table release
    -

    antaresRead 2.2.2 (2019-01-15)

    CRAN release: 2019-01-21

    +

    antaresRead 2.2.2 (2019-01-15)2019-01-21

    BUGFIXES:

    • Duplicated vignette title
    -

    antaresRead 2.2.1 (2018-10-16)

    CRAN release: 2018-10-18

    +

    antaresRead 2.2.1 (2018-10-16)2018-10-18

    BUGFIXES:

    • “.getStartDate()” : was not working correctly with a first-month not equal to “July” (#121)
    • “.getStartDate()” : was not working correctly when a user wants to change options with an opts (#122)
    -

    antaresRead 2.2.0 (2018-09-28)

    CRAN release: 2018-09-28

    +

    antaresRead 2.2.0 (2018-09-28)2018-09-28

    BREAKING CHANGES:

    • “removeVirtualAres()” : as a new logical parameter rowBal, if is TRUE (default) then BALANCE will be corrected by ROW. BAL (#antaresProcessing33)

    NEW FEATURES:

    @@ -249,19 +256,19 @@

    an
  • “writeAntaresH5()” was not working anymore due to a new version of rhdf5 (h5close() does not work anymore). (#110)

    • -

    antaresRead 2.1.2 (2018-06-01)

    CRAN release: 2018-06-04

    +

    antaresRead 2.1.2 (2018-06-01)2018-06-04

    BUGFIXES:

    • getLinks() was sending an error when there are no links in the study.
    -

    antaresRead 2.1.1 (2018-04-28)

    CRAN release: 2018-05-02

    +

    antaresRead 2.1.1 (2018-04-28)2018-05-02

    BUGFIXES:

    • readInputTS() was sending bad values for hydroStorage. (#58)
    • changeTimeStep() will print a warning if the user want to aggregate data. (#54)
    • readAntares() will print warnings when a user want to aggregate mustRun data (#54)
    -

    antaresRead 2.1.0 (2018-02-23)

    CRAN release: 2018-02-23

    +

    antaresRead 2.1.0 (2018-02-23)2018-02-23

    NEW FEATURES:

    • readInputTS() has a new parameter “thermalOutages” that permits to read thermal outages characteristics
    • Call removeVirtualAreas several times in writeAntaresH5()
      • @@ -270,17 +277,17 @@

      an
    • Correction of some bugs due to the new lubridate version

    -

    antaresRead 2.0.2 (2017-11-21)

    CRAN release: 2017-11-21

    +

    antaresRead 2.0.2 (2017-11-21)2017-11-21

    BUGFIXES:

    • Some tests failed in some platforms on CRAN.
    -

    antaresRead 2.0.1 (2017-11-14)

    CRAN release: 2017-11-14

    +

    antaresRead 2.0.1 (2017-11-14)2017-11-14

    BUGFIXES:

    • readLayout() was not taking a list of simOptions.
    -

    antaresRead 2.0.0 (2017-11-03)

    CRAN release: 2017-11-06

    +

    antaresRead 2.0.0 (2017-11-03)2017-11-06

    NEW FEATURES:

    • New function “writeAntaresH5()” convert ANTARES outputs to h5 files.
    • The path parameter of “setSimulationPath()” can be a h5 file.
      • @@ -293,22 +300,22 @@

      an
    • antaresRead() sometimes returned a antaresDataList with element “thermalModulation”. (#51)

    -

    antaresRead 1.1.4 (2017-07-07)

    CRAN release: 2017-07-11

    +

    antaresRead 1.1.4 (2017-07-07)2017-07-11

    BUGFIXES:

    • setSimulation() was crashing with antares v6.0 because of the folder “maps”. (#49)
    -

    antaresRead 1.1.3 (2017-05-30)

    CRAN release: 2017-05-30

    +

    antaresRead 1.1.3 (2017-05-30)2017-05-30

    BUGFIXES:

    • readInputTS was crashing when trying to import cluster data and some clusters were disabled.
    -

    antaresRead 1.1.2 (2017-04-18)

    CRAN release: 2017-04-20

    +

    antaresRead 1.1.2 (2017-04-18)2017-04-20

    BUGFIXES:

    • Fixed an issue that caused compilation to crash on mac OS X
    -

    antaresRead 1.1.0 (2017-03-31)

    +

    antaresRead 1.1.0 (2017-03-31)

    NEW FEATURES:

    • The ‘select’ parameter of readAntares() has been improved. It now accepts new keywords “areas”, “links”, “clusters”, “districts” to indicate which type of data to read,“mcYears” to import detailed results, “misc”, “mustRun”, etc. to import the corresponding input data.
    • A new function setAlias() has been added. It permits to packages developers to define new aliases to use in the ‘select’ parameter of readAntares() in order to help their users to import the required data.
      • @@ -322,13 +329,13 @@

      an
    • readAntares(clusters = “all”) was not working in some situations.

    -

    antaresRead 1.0.0 (2017-02-23)

    +

    antaresRead 1.0.0 (2017-02-23)

    BUGFIXES:

    • In some specific situations, date columns could be filled with NA values. (#26)
    • Many small problems that were detected by R CMD CHECK.
    -

    antaresRead 0.15 (2017-01-25)

    +

    antaresRead 0.15 (2017-01-25)

    BREAKING CHANGES:

    • Parameter “synthesis” has been removed from readAntares. The new behavior is now to import synthetic results when “mcYears” is NULL and to import detailed results when “mcYears” is set.

    NEW FEATURES:

    @@ -341,7 +348,7 @@

    ant
  • Variable “timeId” is now always numeric. Before it was numeric except for annual data where it could be character or factor.

    • -

    antaresRead 0.14 (2016-11-14)

    +

    antaresRead 0.14 (2016-11-14)

    NEW FEATURES:

    • readAntares() has been significantly improved. Depending on the query, the time needed to import data is decreased by 20% up to 95%. In particular, importing data for clusters is now 20 times faster than before. Moreover, the progress bar is now more precise.
    • removeVirtualAreas() has a new parameter “newCols” that permits to choose whether to create new columns containing the production of the virtual areas or to update the existing ones.
      • @@ -350,12 +357,12 @@

      ant
    • New functions as.antaresDataTable and as.antaresDataList have been added to convert compatible objects to these classes.

    -

    antaresRead 0.13 (2016-10-06)

    +

    antaresRead 0.13 (2016-10-06)

    BREAKING CHANGES:

    • add a file LICENSE and copyright to sources files
    -

    antaresRead 0.12 (2016-08-17)

    +

    antaresRead 0.12 (2016-08-17)

    BREAKING CHANGES:

    • The object returned by ‘setSimulationPath’ and ‘simOptions’ has been modified. In particular, paths have been renamed to make their utility clearer. Moreover a new element named ‘linksDef’ contains a table with the specification of each link of the study.

    NEW FEATURES:

    @@ -367,7 +374,7 @@

    ant
  • Solved some performance issues in readAntares() and removeVirtualAreas().

    • -

    antaresRead 0.11 (2016-08-01)

    +

    antaresRead 0.11 (2016-08-01)

    BREAKING CHANGES:

    • The parameters of ‘getLinks’ have been modified because they were unclear. Now user has to to explicitly specify areas to include and/or exclude.

    BUGFIXES:

    @@ -375,17 +382,17 @@

    ant
  • changeTimeStep sometimes generated NA values because of integer overflow.

    • -

    antaresRead 0.10 (2016-07-18)

    +

    antaresRead 0.10 (2016-07-18)

    BREAKING CHANGES: * Variable mustRunModuction has been renamed minGenModulation for consistency with Antares * Similarly in the object returned by setSimulationPath and simOptions, “setList” has been renamed “districtList”

    NEW FEATURES: * Now, when one filters, add, remove or update columns of an object of class ‘antaresDataTable’, the result is still of class ‘antaresDataTable’.

    -

    antaresRead 0.9.1 (2016-07-05)

    +

    antaresRead 0.9.1 (2016-07-05)

    BUGFIXES:

    • readAntares was incorrectly setting attributes of its ouput. This resulted in errors when using functions of the antaresProcessing package.
    -

    antaresRead 0.9 (2016-07-04)

    +

    antaresRead 0.9 (2016-07-04)

    BREAKING CHANGES:

    • The columns returned by readAntares when ‘hydroStorageMaxPower = TRUE’ have been renamed.

    NEW FEATURES:

    @@ -393,7 +400,7 @@

    antar
  • New aliases have been added. One can inspect them with “showAliases()”.

    • -

    antaresRead 0.8 (2016-06-20)

    +

    antaresRead 0.8 (2016-06-20)

    NEW FEATURES:

    • setSimulationPath nows reads costs of unsupplied et spilled energy.
    • ReadLayout computes coordinates for districts and link between them.
      • @@ -403,7 +410,7 @@

      antar
      • Small bug fixes that avoid useless warning messages/

    -

    antaresRead 0.7 (2016-06-07)

    +

    antaresRead 0.7 (2016-06-07)

    BREAKING CHANGES:

    • The package has been renamed “antaresRead”.

    NEW FEATURES:

    @@ -417,7 +424,7 @@

    antar
  • setSimulationPath was not recognising option “apply-filter = add-all” when retrieving district definition.

    • -

    antaresRead 0.6 (2016-05-27)

    +

    antaresRead 0.6 (2016-05-27)

    NEW FEATURES:

    • readAntares and readInputTS always add time columns (time, day, month, hour). changeTimeStep now keeps them if they are present.

    BUGFIXES:

    @@ -427,7 +434,7 @@

    antar
  • In removeVirtualNodes, option “reassignCosts” was not working correctly.

    • -

    antaresRead 0.5 (2016-05-11)

    +

    antaresRead 0.5 (2016-05-11)

    BREAKING CHANGES:

    • To be consistent with Antares, ‘node’ has been replaced by ‘area’ everywhere in the package.
    • Column ‘MWh’ is now named ‘production’ when reading clusters output.
      • @@ -443,7 +450,7 @@

      antar
    • The option ‘mustRun’ in readAntares was not functionning correctly

    -

    antaresRead 0.4 (2016-04-29)

    +

    antaresRead 0.4 (2016-04-29)

    BREAKING CHANGES:

    • The parameters and the output of “readAntares” have been modified. The output has now only three components: nodes, links and clusters. If the user asks other information like hydro storage or links capacities, they are added to the corresponding component. The corresponding parameters now expect TRUE/ FALSE instead of a vector of node or link names.
    • “getLinks” has now same parameters and behavior than “getNodes”
      • @@ -459,7 +466,7 @@

      antar
    • Added package vignette

    -

    antaresRead 0.3 (2016-04-14)

    +

    antaresRead 0.3 (2016-04-14)

    NEW FEATURES:

    • “readAntares” can now read hydro storage, hydro storage maximum power, reserve and links capacity
    • New function “readAntaresNodes”: read all the desired data for a set of nodes
      • @@ -472,7 +479,7 @@

      antar
    • Added this NEWS file :)

    -

    antaresRead 0.2 (2016-04-05)

    +

    antaresRead 0.2 (2016-04-05)

    BREAKING CHANGES:

    • “readOutput” has been renamed “readAntares”

    NEW FEATURES:

    @@ -482,22 +489,28 @@

    antar
  • Nodes and sets are now separated in “readAntares” and “setSimulationPath”
  • aliases for groups of variables in parameter “select” of “readAntares”

    • -
    +
    + + +
    -
    + +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/pkgdown.css b/pkgdown.css new file mode 100644 index 00000000..80ea5b83 --- /dev/null +++ b/pkgdown.css @@ -0,0 +1,384 @@ +/* Sticky footer */ + +/** + * Basic idea: https://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/ + * Details: https://github.com/philipwalton/solved-by-flexbox/blob/master/assets/css/components/site.css + * + * .Site -> body > .container + * .Site-content -> body > .container .row + * .footer -> footer + * + * Key idea seems to be to ensure that .container and __all its parents__ + * have height set to 100% + * + */ + +html, body { + height: 100%; +} + +body { + position: relative; +} + +body > .container { + display: flex; + height: 100%; + flex-direction: column; +} + +body > .container .row { + flex: 1 0 auto; +} + +footer { + margin-top: 45px; + padding: 35px 0 36px; + border-top: 1px solid #e5e5e5; + color: #666; + display: flex; + flex-shrink: 0; +} +footer p { + margin-bottom: 0; +} +footer div { + flex: 1; +} +footer .pkgdown { + text-align: right; +} +footer p { + margin-bottom: 0; +} + +img.icon { + float: right; +} + +/* Ensure in-page images don't run outside their container */ +.contents img { + max-width: 100%; + height: auto; +} + +/* Fix bug in bootstrap (only seen in firefox) */ +summary { + display: list-item; +} + +/* Typographic tweaking ---------------------------------*/ + +.contents .page-header { + margin-top: calc(-60px + 1em); +} + +dd { + margin-left: 3em; +} + +/* Section anchors ---------------------------------*/ + +a.anchor { + display: none; + margin-left: 5px; + width: 20px; + height: 20px; + + background-image: url(./link.svg); + background-repeat: no-repeat; + background-size: 20px 20px; + background-position: center center; +} + +h1:hover .anchor, +h2:hover .anchor, +h3:hover .anchor, +h4:hover .anchor, +h5:hover .anchor, +h6:hover .anchor { + display: inline-block; +} + +/* Fixes for fixed navbar --------------------------*/ + +.contents h1, .contents h2, .contents h3, .contents h4 { + padding-top: 60px; + margin-top: -40px; +} + +/* Navbar submenu --------------------------*/ + +.dropdown-submenu { + position: relative; +} + +.dropdown-submenu>.dropdown-menu { + top: 0; + left: 100%; + margin-top: -6px; + margin-left: -1px; + border-radius: 0 6px 6px 6px; +} + +.dropdown-submenu:hover>.dropdown-menu { + display: block; +} + +.dropdown-submenu>a:after { + display: block; + content: " "; + float: right; + width: 0; + height: 0; + border-color: transparent; + border-style: solid; + border-width: 5px 0 5px 5px; + border-left-color: #cccccc; + margin-top: 5px; + margin-right: -10px; +} + +.dropdown-submenu:hover>a:after { + border-left-color: #ffffff; +} + +.dropdown-submenu.pull-left { + float: none; +} + +.dropdown-submenu.pull-left>.dropdown-menu { + left: -100%; + margin-left: 10px; + border-radius: 6px 0 6px 6px; +} + +/* Sidebar --------------------------*/ + +#pkgdown-sidebar { + margin-top: 30px; + position: -webkit-sticky; + position: sticky; + top: 70px; +} + +#pkgdown-sidebar h2 { + font-size: 1.5em; + margin-top: 1em; +} + +#pkgdown-sidebar h2:first-child { + margin-top: 0; +} + +#pkgdown-sidebar .list-unstyled li { + margin-bottom: 0.5em; +} + +/* bootstrap-toc tweaks ------------------------------------------------------*/ + +/* All levels of nav */ + +nav[data-toggle='toc'] .nav > li > a { + padding: 4px 20px 4px 6px; + font-size: 1.5rem; + font-weight: 400; + color: inherit; +} + +nav[data-toggle='toc'] .nav > li > a:hover, +nav[data-toggle='toc'] .nav > li > a:focus { + padding-left: 5px; + color: inherit; + border-left: 1px solid #878787; +} + +nav[data-toggle='toc'] .nav > .active > a, +nav[data-toggle='toc'] .nav > .active:hover > a, +nav[data-toggle='toc'] .nav > .active:focus > a { + padding-left: 5px; + font-size: 1.5rem; + font-weight: 400; + color: inherit; + border-left: 2px solid #878787; +} + +/* Nav: second level (shown on .active) */ + +nav[data-toggle='toc'] .nav .nav { + display: none; /* Hide by default, but at >768px, show it */ + padding-bottom: 10px; +} + +nav[data-toggle='toc'] .nav .nav > li > a { + padding-left: 16px; + font-size: 1.35rem; +} + +nav[data-toggle='toc'] .nav .nav > li > a:hover, +nav[data-toggle='toc'] .nav .nav > li > a:focus { + padding-left: 15px; +} + +nav[data-toggle='toc'] .nav .nav > .active > a, +nav[data-toggle='toc'] .nav .nav > .active:hover > a, +nav[data-toggle='toc'] .nav .nav > .active:focus > a { + padding-left: 15px; + font-weight: 500; + font-size: 1.35rem; +} + +/* orcid ------------------------------------------------------------------- */ + +.orcid { + font-size: 16px; + color: #A6CE39; + /* margins are required by official ORCID trademark and display guidelines */ + margin-left:4px; + margin-right:4px; + vertical-align: middle; +} + +/* Reference index & topics ----------------------------------------------- */ + +.ref-index th {font-weight: normal;} + +.ref-index td {vertical-align: top; min-width: 100px} +.ref-index .icon {width: 40px;} +.ref-index .alias {width: 40%;} +.ref-index-icons .alias {width: calc(40% - 40px);} +.ref-index .title {width: 60%;} + +.ref-arguments th {text-align: right; padding-right: 10px;} +.ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px} +.ref-arguments .name {width: 20%;} +.ref-arguments .desc {width: 80%;} + +/* Nice scrolling for wide elements --------------------------------------- */ + +table { + display: block; + overflow: auto; +} + +/* Syntax highlighting ---------------------------------------------------- */ + +pre, code, pre code { + background-color: #f8f8f8; + color: #333; +} +pre, pre code { + white-space: pre-wrap; + word-break: break-all; + overflow-wrap: break-word; +} + +pre { + border: 1px solid #eee; +} + +pre .img, pre .r-plt { + margin: 5px 0; +} + +pre .img img, pre .r-plt img { + background-color: #fff; +} + +code a, pre a { + color: #375f84; +} + +a.sourceLine:hover { + text-decoration: none; +} + +.fl {color: #1514b5;} +.fu {color: #000000;} /* function */ +.ch,.st {color: #036a07;} /* string */ +.kw {color: #264D66;} /* keyword */ +.co {color: #888888;} /* comment */ + +.error {font-weight: bolder;} +.warning {font-weight: bolder;} + +/* Clipboard --------------------------*/ + +.hasCopyButton { + position: relative; +} + +.btn-copy-ex { + position: absolute; + right: 0; + top: 0; + visibility: hidden; +} + +.hasCopyButton:hover button.btn-copy-ex { + visibility: visible; +} + +/* headroom.js ------------------------ */ + +.headroom { + will-change: transform; + transition: transform 200ms linear; +} +.headroom--pinned { + transform: translateY(0%); +} +.headroom--unpinned { + transform: translateY(-100%); +} + +/* mark.js ----------------------------*/ + +mark { + background-color: rgba(255, 255, 51, 0.5); + border-bottom: 2px solid rgba(255, 153, 51, 0.3); + padding: 1px; +} + +/* vertical spacing after htmlwidgets */ +.html-widget { + margin-bottom: 10px; +} + +/* fontawesome ------------------------ */ + +.fab { + font-family: "Font Awesome 5 Brands" !important; +} + +/* don't display links in code chunks when printing */ +/* source: https://stackoverflow.com/a/10781533 */ +@media print { + code a:link:after, code a:visited:after { + content: ""; + } +} + +/* Section anchors --------------------------------- + Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71 +*/ + +div.csl-bib-body { } +div.csl-entry { + clear: both; +} +.hanging-indent div.csl-entry { + margin-left:2em; + text-indent:-2em; +} +div.csl-left-margin { + min-width:2em; + float:left; +} +div.csl-right-inline { + margin-left:2em; + padding-left:1em; +} +div.csl-indent { + margin-left: 2em; +} diff --git a/pkgdown.js b/pkgdown.js index 5fccd9c0..6f0eee40 100644 --- a/pkgdown.js +++ b/pkgdown.js @@ -2,30 +2,70 @@ (function($) { $(function() { - $('nav.navbar').headroom(); + $('.navbar-fixed-top').headroom(); - Toc.init({ - $nav: $("#toc"), - $scope: $("main h2, main h3, main h4, main h5, main h6") + $('body').css('padding-top', $('.navbar').height() + 10); + $(window).resize(function(){ + $('body').css('padding-top', $('.navbar').height() + 10); }); - if ($('#toc').length) { - $('body').scrollspy({ - target: '#toc', - offset: $("nav.navbar").outerHeight() + 1 - }); + $('[data-toggle="tooltip"]').tooltip(); + + var cur_path = paths(location.pathname); + var links = $("#navbar ul li a"); + var max_length = -1; + var pos = -1; + for (var i = 0; i < links.length; i++) { + if (links[i].getAttribute("href") === "#") + continue; + // Ignore external links + if (links[i].host !== location.host) + continue; + + var nav_path = paths(links[i].pathname); + + var length = prefix_length(nav_path, cur_path); + if (length > max_length) { + max_length = length; + pos = i; + } } - // Activate popovers - $('[data-bs-toggle="popover"]').popover({ - container: 'body', - html: true, - trigger: 'focus', - placement: "top", - sanitize: false, - }); + // Add class to parent
  • , and enclosing
  • if in dropdown + if (pos >= 0) { + var menu_anchor = $(links[pos]); + menu_anchor.parent().addClass("active"); + menu_anchor.closest("li.dropdown").addClass("active"); + } + }); + + function paths(pathname) { + var pieces = pathname.split("/"); + pieces.shift(); // always starts with / + + var end = pieces[pieces.length - 1]; + if (end === "index.html" || end === "") + pieces.pop(); + return(pieces); + } + + // Returns -1 if not found + function prefix_length(needle, haystack) { + if (needle.length > haystack.length) + return(-1); - $('[data-bs-toggle="tooltip"]').tooltip(); + // Special case for length-0 haystack, since for loop won't run + if (haystack.length === 0) { + return(needle.length === 0 ? 0 : -1); + } + + for (var i = 0; i < haystack.length; i++) { + if (needle[i] != haystack[i]) + return(i); + } + + return(haystack.length); + } /* Clipboard --------------------------*/ @@ -38,7 +78,7 @@ if(ClipboardJS.isSupported()) { $(document).ready(function() { - var copyButton = ""; + var copyButton = ""; $("div.sourceCode").addClass("hasCopyButton"); @@ -49,108 +89,20 @@ $('.btn-copy-ex').tooltip({container: 'body'}); // Initialize clipboard: - var clipboard = new ClipboardJS('[data-clipboard-copy]', { + var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', { text: function(trigger) { return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, ""); } }); - clipboard.on('success', function(e) { + clipboardBtnCopies.on('success', function(e) { changeTooltipMessage(e.trigger, 'Copied!'); e.clearSelection(); }); - clipboard.on('error', function() { + clipboardBtnCopies.on('error', function() { changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy'); }); - }); } - - /* Search marking --------------------------*/ - var url = new URL(window.location.href); - var toMark = url.searchParams.get("q"); - var mark = new Mark("main#main"); - if (toMark) { - mark.mark(toMark, { - accuracy: { - value: "complementary", - limiters: [",", ".", ":", "/"], - } - }); - } - - /* Search --------------------------*/ - /* Adapted from https://github.com/rstudio/bookdown/blob/2d692ba4b61f1e466c92e78fd712b0ab08c11d31/inst/resources/bs4_book/bs4_book.js#L25 */ - // Initialise search index on focus - var fuse; - $("#search-input").focus(async function(e) { - if (fuse) { - return; - } - - $(e.target).addClass("loading"); - var response = await fetch($("#search-input").data("search-index")); - var data = await response.json(); - - var options = { - keys: ["what", "text", "code"], - ignoreLocation: true, - threshold: 0.1, - includeMatches: true, - includeScore: true, - }; - fuse = new Fuse(data, options); - - $(e.target).removeClass("loading"); - }); - - // Use algolia autocomplete - var options = { - autoselect: true, - debug: true, - hint: false, - minLength: 2, - }; - var q; -async function searchFuse(query, callback) { - await fuse; - - var items; - if (!fuse) { - items = []; - } else { - q = query; - var results = fuse.search(query, { limit: 20 }); - items = results - .filter((x) => x.score <= 0.75) - .map((x) => x.item); - if (items.length === 0) { - items = [{dir:"Sorry 😿",previous_headings:"",title:"No results found.",what:"No results found.",path:window.location.href}]; - } - } - callback(items); -} - $("#search-input").autocomplete(options, [ - { - name: "content", - source: searchFuse, - templates: { - suggestion: (s) => { - if (s.title == s.what) { - return `${s.dir} >
    ${s.title}
    `; - } else if (s.previous_headings == "") { - return `${s.dir} >
    ${s.title}
    > ${s.what}`; - } else { - return `${s.dir} >
    ${s.title}
    > ${s.previous_headings} > ${s.what}`; - } - }, - }, - }, - ]).on('autocomplete:selected', function(event, s) { - window.location.href = s.path + "?q=" + q + "#" + s.id; - }); - }); })(window.jQuery || window.$) - - diff --git a/pkgdown.yml b/pkgdown.yml index 70f181f6..7af33ce4 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -4,7 +4,7 @@ pkgdown_sha: ~ articles: antaresH5: antaresH5.html antaresRead: antaresRead.html -last_built: 2024-01-31T16:37Z +last_built: 2024-02-01T09:30Z urls: reference: https://rte-antares-rpackage.github.io/antaresRead/reference article: https://rte-antares-rpackage.github.io/antaresRead/articles diff --git a/reference/API-methods.html b/reference/API-methods.html index f0da4f39..4e6b3841 100644 --- a/reference/API-methods.html +++ b/reference/API-methods.html @@ -1,65 +1,71 @@ -API methods — API-methods • antaresReadAPI methods — API-methods • antaresRead - Skip to contents + -
    -
    -
    -

    API methods

    - Source: R/API-methods.R -
    API-methods.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    API methods

    + Source: R/API-methods.R +
    -
    +

    API methods

    -
    -

    Usage

    + 
    api_get(opts, endpoint, ..., default_endpoint = "v1/studies")
 
 api_post(opts, endpoint, ..., default_endpoint = "v1/studies")
@@ -69,8 +75,8 @@ 
    Usage
 api_delete(opts, endpoint, ..., default_endpoint = "v1/studies")
    -
    -

    Arguments

    +
    +

    Arguments

    opts

    Antares simulation options or a list with an host = slot.

    @@ -88,15 +94,15 @@

    Arguments -

    Value

    +
    +

    Value

    Response from the API.

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 
 # List studies with local API
@@ -108,22 +114,26 @@ 
    Examples}
    -
    +

    + +
    -
    + diff --git a/reference/aggregatate_mc_all.html b/reference/aggregatate_mc_all.html index 65cdc180..bfa7ac97 100644 --- a/reference/aggregatate_mc_all.html +++ b/reference/aggregatate_mc_all.html @@ -1,65 +1,71 @@ -Creation of Mc_all new (only antares > V6) — parAggregateMCall • antaresReadCreation of Mc_all new (only antares > V6) — parAggregateMCall • antaresRead - Skip to contents + -
    -
    -
    -

    Creation of Mc_all new (only antares > V6)

    - Source: R/aggregateResult.R -
    aggregatate_mc_all.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Creation of Mc_all new (only antares > V6)

    + Source: R/aggregateResult.R +
    -
    +

    Creation of Mc_all new (only antares > V6)

    -
    -

    Usage

    + 
    parAggregateMCall(
   opts,
   nbcl = 8,
@@ -86,8 +92,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    opts

    list of simulation parameters returned by the function setSimulationPath

    @@ -132,22 +138,26 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/aggregatate_mc_all_old.html b/reference/aggregatate_mc_all_old.html index 0b1be67a..017dcd17 100644 --- a/reference/aggregatate_mc_all_old.html +++ b/reference/aggregatate_mc_all_old.html @@ -1,65 +1,71 @@ -Creation of Mc_all (only antares > V6) — aggregateResult_old • antaresReadCreation of Mc_all (only antares > V6) — aggregateResult_old • antaresRead - Skip to contents + -
    -
    -
    -

    Creation of Mc_all (only antares > V6)

    - Source: R/aggregateResult.R -
    aggregatate_mc_all_old.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Creation of Mc_all (only antares > V6)

    + Source: R/aggregateResult.R +
    -
    +

    Creation of Mc_all (only antares > V6)

    -
    -

    Usage

    + 
    aggregateResult_old(
   opts,
   verbose = 1,
@@ -82,8 +88,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    opts

    list of simulation parameters returned by the function setSimulationPath

    @@ -121,8 +127,8 @@

    Arguments -

    Examples

    +
    +

    Examples

    if (FALSE) {
    aggregateResult(opts)
 
@@ -130,22 +136,26 @@ 
    Examples
    -

    +
    + +
    -
    + diff --git a/reference/antaresRead-package.html b/reference/antaresRead-package.html index bba63bf2..e1db0723 100644 --- a/reference/antaresRead-package.html +++ b/reference/antaresRead-package.html @@ -1,72 +1,80 @@ -antaresRead: Import, Manipulate and Explore the Results of an 'Antares' Simulation — antaresRead-package • antaresReadantaresRead: Import, Manipulate and Explore the Results of an 'Antares' Simulation — antaresRead-package • antaresRead - Skip to contents + -
    -
    -
    -

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

    - Source: R/antaresRead-package.R -
    antaresRead-package.Rd
    +
    +
    +
    + + + +
    +
    +
    +

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

    + Source: R/antaresRead-package.R +
    -
    +

    Import, manipulate and explore results generated by 'Antares', a powerful open source software developed by RTE (Réseau de Transport d’Électricité) to simulate and study electric power systems (more information about 'Antares' here : https://antares-simulator.org/).

    -
    -

    See also

    + -
    -

    Author

    +
    +

    Author

    Maintainer: Tatiana Vargas tatiana.vargas@rte-france.com

    Authors:

    • Jalal-Edine ZAWAM

    • Francois Guillem

      • @@ -80,22 +88,26 @@

      Author<

    • RTE [copyright holder]

    -
    +
    + +
    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/as.antaresDataList.html b/reference/as.antaresDataList.html index 9983cd04..c2719511 100644 --- a/reference/as.antaresDataList.html +++ b/reference/as.antaresDataList.html @@ -1,68 +1,71 @@ -Convert objects to antaresDataTable — as.antaresDataList • antaresReadConvert objects to antaresDataTable — as.antaresDataList • antaresRead - Skip to contents - - -
    -
    -
    -

    Convert objects to antaresDataTable

    - Source: R/asAntaresDataList.R -
    as.antaresDataList.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Convert objects to antaresDataTable

    + Source: R/asAntaresDataList.R +
    -
    +

    This function converts a list of tables or table into an antaresDataList object.

    An antaresDataList is a list of tables of classantaresDataTable. @@ -70,8 +73,7 @@ simulation options.

    -
    -

    Usage

    + 
    as.antaresDataList(x, ...)
 
 # S3 method for antaresDataTable
@@ -89,8 +91,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    x

    Data.frame or data.table to convert to a an antaresDataTable.

    @@ -120,29 +122,33 @@

    Arguments -

    Value

    +
    +

    Value

    antaresDataList object.

    -

    +
    + +
    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/as.antaresDataTable.html b/reference/as.antaresDataTable.html index 6dcaf0a0..4067c0c6 100644 --- a/reference/as.antaresDataTable.html +++ b/reference/as.antaresDataTable.html @@ -1,68 +1,71 @@ -Convert objects to antaresDataTable — as.antaresDataTable • antaresReadConvert objects to antaresDataTable — as.antaresDataTable • antaresRead - Skip to contents - - -
    -
    -
    -

    Convert objects to antaresDataTable

    - Source: R/asAntaresDataTable.R -
    as.antaresDataTable.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Convert objects to antaresDataTable

    + Source: R/asAntaresDataTable.R +
    -
    +

    This function converts a data.frame or a data.table into an antaresDataTable object.

    An antaresDataTable is simply a data.table with additional @@ -70,16 +73,15 @@ options.

    -
    -

    Usage

    + 
    as.antaresDataTable(x, ...)
 
 # S3 method for data.frame
 as.antaresDataTable(x, synthesis, timeStep, type, opts = simOptions(), ...)
    -
    -

    Arguments

    +
    +

    Arguments

    x

    object to convert to a an antaresDataList.

    @@ -104,29 +106,33 @@

    Arguments -

    Value

    +
    +

    Value

    antaresDataTable object.

    -

    +
    + +
    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/changeTimeStep.html b/reference/changeTimeStep.html index 634b61e5..9e50077c 100644 --- a/reference/changeTimeStep.html +++ b/reference/changeTimeStep.html @@ -1,76 +1,80 @@ -Change the timestep of an output — changeTimeStep • antaresReadChange the timestep of an output — changeTimeStep • antaresRead - Skip to contents - - -
    -
    -
    -

    Change the timestep of an output

    - Source: R/changeTimeStep.R -
    changeTimeStep.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Change the timestep of an output

    + Source: R/changeTimeStep.R +
    -
    +

    This function changes the timestep of a table or an antaresData object and performs the required aggregation or desaggregation. We can specify (des)aggregate functions by columns, see the param fun.

    -
    -

    Usage

    + 
    changeTimeStep(x, newTimeStep, oldTimeStep, fun = "sum", opts = simOptions())
    -
    -

    Arguments

    +
    +

    Arguments

    x

    data.table with a column "timeId" or an object of class "antaresDataList"

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

    ArgumentssetSimulationPath

    -
    -

    Value

    +
    +

    Value

    Either a data.table or an object of class "antaresDataList" depending on the @@ -108,8 +112,8 @@

    Value

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 setSimulationPath()
 
@@ -127,22 +131,26 @@ 
    Examples
    -
    +
    + +
    -
    + diff --git a/reference/copyToClipboard.html b/reference/copyToClipboard.html index 99a8450c..302f5651 100644 --- a/reference/copyToClipboard.html +++ b/reference/copyToClipboard.html @@ -1,76 +1,81 @@ -Copy data to the clipboard — copyToClipboard • antaresReadCopy data to the clipboard — copyToClipboard • antaresRead - Skip to contents + -
    -
    -
    -

    Copy data to the clipboard

    - Source: R/copyToClipboard.R -
    copyToClipboard.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Copy data to the clipboard

    + Source: R/copyToClipboard.R +
    -
    +

    copyToClipboard is a utility function that copies data to the clipboard. The data can then be copied in another program like excel.

    -
    -

    Usage

    + 
    copyToClipboard(x, ...)
 
 # S3 method for antaresDataList
 copyToClipboard(x, what, ...)
    -
    -

    Arguments

    +
    +

    Arguments

    x

    an object used to select a method.

    @@ -84,23 +89,23 @@

    Arguments -

    Value

    +
    +

    Value

    The function does not return anything. It is only used to interact with the clipboard

    -
    -

    Note

    +
    +

    Note

    The function is useful only for small data objects: for a table, only the 50000 rows are copied to clipboard. If the table to copy is longer, either use filters to reduce the number of rows or write the table in text file with write.table

    -
    -

    Examples

    +
    +

    Examples

     # This only works on Windows systems
 if (FALSE) {
 x <- data.frame(a = sample(10), b = sample(10))
@@ -112,22 +117,26 @@ 
    Examples
    -
    +
    + +

    -
    + diff --git a/reference/dot-getOptionsH5.html b/reference/dot-getOptionsH5.html index bb56b93a..b2597714 100644 --- a/reference/dot-getOptionsH5.html +++ b/reference/dot-getOptionsH5.html @@ -1,91 +1,101 @@ -Get H5 options — .getOptionsH5 • antaresReadGet H5 options — .getOptionsH5 • antaresRead - Skip to contents + -
    -
    -
    -

    Get H5 options

    - Source: R/h5_setSimulationPathH5.R -
    dot-getOptionsH5.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Get H5 options

    + Source: R/h5_setSimulationPathH5.R +
    -
    +

    Get H5 options

    -
    -

    Usage

    + 
    .getOptionsH5(path)
    -
    -

    Arguments

    +
    +

    Arguments

    path

    character path of h5 file

    -
    +
    + +
    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/dot-h5ReadAntares.html b/reference/dot-h5ReadAntares.html index 53ffd5a3..1b936f4b 100644 --- a/reference/dot-h5ReadAntares.html +++ b/reference/dot-h5ReadAntares.html @@ -1,65 +1,71 @@ -Read data — .h5ReadAntares • antaresReadRead data — .h5ReadAntares • antaresRead - Skip to contents + -
    -
    -
    -

    Read data

    - Source: R/h5_antaresReadH5.R -
    dot-h5ReadAntares.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Read data

    + Source: R/h5_antaresReadH5.R +
    -
    +

    Read data

    -
    -

    Usage

    + 
    .h5ReadAntares(
   path,
   areas = NULL,
@@ -83,8 +89,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    path

    character path of h5file to load

    @@ -162,22 +168,26 @@

    Arguments

    +
    + +
    -
    + diff --git a/reference/dot-writeAntaresH5Fun.html b/reference/dot-writeAntaresH5Fun.html index 602d9003..ef0cc1ea 100644 --- a/reference/dot-writeAntaresH5Fun.html +++ b/reference/dot-writeAntaresH5Fun.html @@ -1,65 +1,71 @@ -Convert antares output to h5 file — .writeAntaresH5Fun • antaresReadConvert antares output to h5 file — .writeAntaresH5Fun • antaresRead - Skip to contents + -
    -
    -
    -

    Convert antares output to h5 file

    - Source: R/h5_writeH5ByYear.R -
    dot-writeAntaresH5Fun.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Convert antares output to h5 file

    + Source: R/h5_writeH5ByYear.R +
    -
    +

    Convert antares output to h5 file

    -
    -

    Usage

    + 
    .writeAntaresH5Fun(
   path,
   timeSteps,
@@ -84,21 +90,26 @@ 
    Usage
    -
    +
    + +
    -
    + diff --git a/reference/dot-writeIni.html b/reference/dot-writeIni.html index a90c3256..37277799 100644 --- a/reference/dot-writeIni.html +++ b/reference/dot-writeIni.html @@ -1,70 +1,76 @@ -Write ini file from list obtain by antaresRead:::readIniFile and modify by user — .writeIni • antaresReadWrite ini file from list obtain by antaresRead:::readIniFile and modify by user — .writeIni • antaresRead - Skip to contents + -
    -
    -
    -

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

    - Source: R/aggregateResult.R -
    dot-writeIni.Rd
    +
    +
    +
    + + + +
    +
    +
    +

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

    + Source: R/aggregateResult.R +
    -
    +

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

    -
    -

    Usage

    + 
    .writeIni(listData, pathIni, overwrite = FALSE)
    -
    -

    Arguments

    +
    +

    Arguments

    listData

    list, modified list obtained by antaresRead:::readIniFile.

    @@ -78,8 +84,8 @@

    Arguments -

    Examples

    +
    +

    Examples

    
 if (FALSE) {
 pathIni <- "D:/exemple_test/settings/generaldata.ini"
@@ -91,22 +97,26 @@ 
    Examples
    -

    +
    + +
    -
    + diff --git a/reference/extractDataList.html b/reference/extractDataList.html index 1a85261a..b74ac9e9 100644 --- a/reference/extractDataList.html +++ b/reference/extractDataList.html @@ -1,68 +1,71 @@ -Format data PPSE-style — extractDataList • antaresRead - Skip to contents - - -
    -
    -
    -

    Format data PPSE-style

    - Source: R/extractDataList.R -
    extractDataList.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Format data PPSE-style

    + Source: R/extractDataList.R +
    -
    +

    This function converts an "readAntares" object in the data structure used by PPSE : instead of having one table for areas, one for links and one for clusters, the function creates a list with one element per area. Each element @@ -70,13 +73,12 @@ of the area containing the production of this cluster.

    -
    -

    Usage

    + 
    extractDataList(x, areas = NULL)
    -
    -

    Arguments

    +
    +

    Arguments

    x

    object of class "antaresData" or "antaresTable" created by the function readAntares

    @@ -87,8 +89,8 @@

    Arguments -

    Value

    +
    +

    Value

    a list of data.tables with one element per area. The list also @@ -97,22 +99,26 @@

    Value

    -

    +
    + +
    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/getAreas.html b/reference/getAreas.html index dec64a76..e148f55d 100644 --- a/reference/getAreas.html +++ b/reference/getAreas.html @@ -1,71 +1,75 @@ -Select and exclude areas — getAreas • antaresReadSelect and exclude areas — getAreas • antaresRead - Skip to contents - - -
    -
    -
    -

    Select and exclude areas

    - Source: R/getAreas.R -
    getAreas.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Select and exclude areas

    + Source: R/getAreas.R +
    -
    +

    getAreas and getDistricts are utility functions that builds list of areas or districts by using regular expressions to select and/or exclude areas/districts

    -
    -

    Usage

    + 
    getAreas(
   select = NULL,
   exclude = NULL,
@@ -87,8 +91,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    select

    Character vector. If regexpSelect is TRUE, this vector is interpreted as a list of regular expressions. Else it is interpreted as a @@ -129,34 +133,38 @@

    Arguments -

    Value

    +
    +

    Value

    A character vector containing the name of the areas/districts satisfying the rules defined by the parameters.

    -
    -

    See also

    +
    +

    See also

    getLinks

    -
    +

    + +
    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/getGeographicTrimming.html b/reference/getGeographicTrimming.html index df9dfe6e..661cdc4d 100644 --- a/reference/getGeographicTrimming.html +++ b/reference/getGeographicTrimming.html @@ -1,70 +1,76 @@ -Read geographic trimming (filtering) options — getGeographicTrimming • antaresReadRead geographic trimming (filtering) options — getGeographicTrimming • antaresRead - Skip to contents + -
    -
    -
    -

    Read geographic trimming (filtering) options

    - Source: R/getGeographicTrimming.R -
    getGeographicTrimming.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Read geographic trimming (filtering) options

    + Source: R/getGeographicTrimming.R +
    -
    +

    Read geographic trimming (filtering) options

    -
    -

    Usage

    + 
    getGeographicTrimming(areas = NULL, links = TRUE, opts = simOptions())
    -
    -

    Arguments

    +
    +

    Arguments

    areas

    Character. vector of areas

    @@ -77,29 +83,33 @@

    Arguments -

    Value

    +
    +

    Value

    list of filtering options for areas and links

    -

    +
    + +
    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/getIdCols.html b/reference/getIdCols.html index 577a8723..e0c8b38d 100644 --- a/reference/getIdCols.html +++ b/reference/getIdCols.html @@ -1,97 +1,107 @@ -get Id columns — getIdCols • antaresReadget Id columns — getIdCols • antaresRead - Skip to contents + -
    -
    -
    -

    get Id columns

    - Source: R/getIds.R -
    getIdCols.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    get Id columns

    + Source: R/getIds.R +
    -
    +

    getIdCols return the id columns of an AntaresDataTable

    -
    -

    Usage

    + 
    getIdCols(x = NULL)
    -
    -

    Arguments

    +
    +

    Arguments

    x

    an AntaresDataTable.

    -
    -

    Value

    +
    +

    Value

    A character vector containing the name of the id columns of an antaresDataTable

    -
    +
    + +
    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/getLinks.html b/reference/getLinks.html index f6aa8a8a..e726f073 100644 --- a/reference/getLinks.html +++ b/reference/getLinks.html @@ -1,65 +1,71 @@ -Retrieve links connected to a set of areas — getLinks • antaresReadRetrieve links connected to a set of areas — getLinks • antaresRead - Skip to contents + -
    -
    -
    -

    Retrieve links connected to a set of areas

    - Source: R/getLinks.R -
    getLinks.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Retrieve links connected to a set of areas

    + Source: R/getLinks.R +
    -
    +

    This function finds the names of the links connected to a set of areas.

    -
    -

    Usage

    + 
    getLinks(
   areas = NULL,
   exclude = NULL,
@@ -71,8 +77,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    areas

    Vector containing area names. It represents the set of areas we are interested in. If NULL, all areas of the study are used.

    @@ -118,8 +124,8 @@

    Arguments -

    Value

    +
    +

    Value

    If namesOnly = TRUE the function returns a vector containing link names

    @@ -153,8 +159,8 @@

    Value

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 
 # Get all links of a study
@@ -177,22 +183,26 @@ 
    Examples
    -
    +

    + +
    -
    + diff --git a/reference/hvdcModification.html b/reference/hvdcModification.html index ab6b4822..7e51be4e 100644 --- a/reference/hvdcModification.html +++ b/reference/hvdcModification.html @@ -1,70 +1,76 @@ -hvdc straitement — hvdcModification • antaresReadhvdc straitement — hvdcModification • antaresRead - Skip to contents + -
    -
    -
    -

    hvdc straitement

    - Source: R/hvdcModification.R -
    hvdcModification.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    hvdc straitement

    + Source: R/hvdcModification.R +
    -
    +

    usage for hvdc

    -
    -

    Usage

    + 
    hvdcModification(data, removeHvdcAreas = TRUE, reafectLinks = FALSE)
    -
    -

    Arguments

    +
    +

    Arguments

    data

    antaresDataList data to apply straitement

    @@ -78,8 +84,8 @@

    Arguments -

    Examples

    +
    +

    Examples

    if (FALSE) {
 
 data <- readAntares(areas = 'all', links = 'all')
@@ -90,22 +96,26 @@ 
    Examples
    -

    +
    + +
    -
    + diff --git a/reference/index.html b/reference/index.html index 0dffb2b7..499ecc9a 100644 --- a/reference/index.html +++ b/reference/index.html @@ -1,289 +1,253 @@ -Function reference • antaresReadFunction reference • antaresRead - Skip to contents + -
    -
    -
    -

    Function reference

    -
    +
    +
    +
    -
    -

    All functions

    - - -
    - - - +
    +
    +
    +

    Reference

    +
    -
    - - api_get() api_post() api_put() api_delete() -
    -
    API methods
    -
    - - parAggregateMCall() aggregateResult() -
    -
    Creation of Mc_all new (only antares > V6)
    -
    - - aggregateResult_old() parAggregateMCall_old() -
    -
    Creation of Mc_all (only antares > V6)
    -
    - - as.antaresDataList() -
    -
    Convert objects to antaresDataTable
    -
    - - as.antaresDataTable() -
    -
    Convert objects to antaresDataTable
    -
    - - changeTimeStep() -
    -
    Change the timestep of an output
    -
    - - copyToClipboard() -
    -
    Copy data to the clipboard
    -
    - - .writeIni() -
    -
    Write ini file from list obtain by antaresRead:::readIniFile and modify by user
    -
    - - extractDataList() -
    -
    Format data PPSE-style
    -
    - - getAreas() getDistricts() -
    -
    Select and exclude areas
    -
    - - getGeographicTrimming() -
    -
    Read geographic trimming (filtering) options
    -
    - - getIdCols() -
    -
    get Id columns
    -
    - - getLinks() -
    -
    Retrieve links connected to a set of areas
    -
    - - hvdcModification() -
    -
    hvdc straitement
    -
    - - isH5Opts() -
    -
    Test if opts is h5
    -
    - - mergeDigests() -
    -
    Merge two digests
    -
    - - ponderateMcAggregation() -
    -
    Mcyear aggregation weigthed by wd
    -
    - - readIni() readIniFile() readIniAPI() -
    -
    Read configuration options from file or API
    -
    - - readAntares() -
    -
    Read the data of an Antares simulation
    -
    - - readAntaresAreas() -
    -
    Read output for a list of areas
    -
    - - readAntaresClusters() -
    -
    Read output for a list of clusters
    -
    - - readBindingConstraints() -
    -
    Read binding constraints
    -
    - - readClusterDesc() readClusterResDesc() readClusterSTDesc() -
    -
    Import clusters description
    -
    - - readDigestFile() -
    -
    Read digest file
    -
    - - readInputRES() -
    -
    Read Input RES time series
    -
    - - readInputTS() -
    -
    Read Input time series
    -
    - - readInputThermal() -
    -
    Read Input thermal time series
    -
    - - readLayout() -
    -
    Read areas layout
    -
    - - readOptimCriteria() -
    -
    Read Optimization Criteria
    -
    - - removeVirtualAreas() -
    -
    Remove virtual areas
    -
    - - showAliases() setAlias() getAlias() -
    -
    show aliases for variables
    -
    - - setHvdcAreas() -
    -
    Set hvdc areas
    -
    - - setRam() -
    -
    Specify RAM limit
    -
    - - setSimulationPath() setSimulationPathAPI() -
    -
    Set Path to an Antares simulation
    -
    - - setTimeoutAPI() -
    -
    Change API Timeout
    -
    - - simOptions() -
    -
    Extract simulation options
    -
    - - subset(<antaresDataList>) -
    -
    Subset an antaresDataList
    -
    - - summary(<bindingConstraints>) -
    -
    Display equation of binding constraint
    -
    - - viewAntares() -
    -
    View the content of an antares output
    -
    - - writeAntaresH5() -
    -
    Convert antares output to h5 file
    -
    - - writeDigest() -
    -
    Write digest file
    -
    -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +

    All functions

    +

    +
    +

    api_get() api_post() api_put() api_delete()

    +

    API methods

    +

    parAggregateMCall() aggregateResult()

    +

    Creation of Mc_all new (only antares > V6)

    +

    aggregateResult_old() parAggregateMCall_old()

    +

    Creation of Mc_all (only antares > V6)

    +

    as.antaresDataList()

    +

    Convert objects to antaresDataTable

    +

    as.antaresDataTable()

    +

    Convert objects to antaresDataTable

    +

    changeTimeStep()

    +

    Change the timestep of an output

    +

    copyToClipboard()

    +

    Copy data to the clipboard

    +

    .writeIni()

    +

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

    +

    extractDataList()

    +

    Format data PPSE-style

    +

    getAreas() getDistricts()

    +

    Select and exclude areas

    +

    getGeographicTrimming()

    +

    Read geographic trimming (filtering) options

    +

    getIdCols()

    +

    get Id columns

    +

    getLinks()

    +

    Retrieve links connected to a set of areas

    +

    hvdcModification()

    +

    hvdc straitement

    +

    isH5Opts()

    +

    Test if opts is h5

    +

    mergeDigests()

    +

    Merge two digests

    +

    ponderateMcAggregation()

    +

    Mcyear aggregation weigthed by wd

    +

    readIni() readIniFile() readIniAPI()

    +

    Read configuration options from file or API

    +

    readAntares()

    +

    Read the data of an Antares simulation

    +

    readAntaresAreas()

    +

    Read output for a list of areas

    +

    readAntaresClusters()

    +

    Read output for a list of clusters

    +

    readBindingConstraints()

    +

    Read binding constraints

    +

    readClusterDesc() readClusterResDesc() readClusterSTDesc()

    +

    Import clusters description

    +

    readDigestFile()

    +

    Read digest file

    +

    readInputRES()

    +

    Read Input RES time series

    +

    readInputTS()

    +

    Read Input time series

    +

    readInputThermal()

    +

    Read Input thermal time series

    +

    readLayout()

    +

    Read areas layout

    +

    readOptimCriteria()

    +

    Read Optimization Criteria

    +

    removeVirtualAreas()

    +

    Remove virtual areas

    +

    showAliases() setAlias() getAlias()

    +

    show aliases for variables

    +

    setHvdcAreas()

    +

    Set hvdc areas

    +

    setRam()

    +

    Specify RAM limit

    +

    setSimulationPath() setSimulationPathAPI()

    +

    Set Path to an Antares simulation

    +

    setTimeoutAPI()

    +

    Change API Timeout

    +

    simOptions()

    +

    Extract simulation options

    +

    subset(<antaresDataList>)

    +

    Subset an antaresDataList

    +

    summary(<bindingConstraints>)

    +

    Display equation of binding constraint

    +

    viewAntares()

    +

    View the content of an antares output

    +

    writeAntaresH5()

    +

    Convert antares output to h5 file

    +

    writeDigest()

    +

    Write digest file

    + + +
    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/isH5Opts.html b/reference/isH5Opts.html index 24c0a90f..51501e00 100644 --- a/reference/isH5Opts.html +++ b/reference/isH5Opts.html @@ -1,91 +1,101 @@ -Test if opts is h5 — isH5Opts • antaresReadTest if opts is h5 — isH5Opts • antaresRead - Skip to contents + -
    -
    -
    -

    Test if opts is h5

    - Source: R/h5utils.R -
    isH5Opts.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Test if opts is h5

    + Source: R/h5utils.R +
    -
    +

    Test if the value returned by setSimulationPath() is referring to an h5 file

    -
    -

    Usage

    + 
    isH5Opts(opts)
    -
    -

    Arguments

    +
    +

    Arguments

    opts

    , opts

    -
    +
    + +
    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/mergeDigests.html b/reference/mergeDigests.html index 157debec..730dab60 100644 --- a/reference/mergeDigests.html +++ b/reference/mergeDigests.html @@ -1,70 +1,76 @@ -Merge two digests — mergeDigests • antaresReadMerge two digests — mergeDigests • antaresRead - Skip to contents + -
    -
    -
    -

    Merge two digests

    - Source: R/digest.R -
    mergeDigests.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Merge two digests

    + Source: R/digest.R +
    -
    +

    Merge two digests

    -
    -

    Usage

    + 
    mergeDigests(digest_new, digest_ori)
    -
    -

    Arguments

    +
    +

    Arguments

    digest_new

    new digest with missing lines

    @@ -73,34 +79,38 @@

    Arguments -

    Value

    +
    +

    Value

    updated digest list of 5 tables (begin, areas, middle, links lin., links quad.)

    -
    -

    See also

    +
    +

    See also

    readDigestFile

    -
    +

    + +
    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/ponderateMcAggregation.html b/reference/ponderateMcAggregation.html index 960d724a..ba1779dc 100644 --- a/reference/ponderateMcAggregation.html +++ b/reference/ponderateMcAggregation.html @@ -1,70 +1,76 @@ -Mcyear aggregation weigthed by wd — ponderateMcAggregation • antaresReadMcyear aggregation weigthed by wd — ponderateMcAggregation • antaresRead - Skip to contents + -
    -
    -
    -

    Mcyear aggregation weigthed by wd

    - Source: R/ponderateMcAggregation.R -
    ponderateMcAggregation.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Mcyear aggregation weigthed by wd

    + Source: R/ponderateMcAggregation.R +
    -
    +

    Mcyear aggregation weigthed by wd

    -
    -

    Usage

    + 
    ponderateMcAggregation(x, fun = weighted.mean, ...)
    -
    -

    Arguments

    +
    +

    Arguments

    x

    antaresData data import with antaresRead

    @@ -78,8 +84,8 @@

    Arguments -

    Examples

    +
    +

    Examples

    if (FALSE) {
   data <- readAntares(areas = 'all', mcYears = 'all')
   ponderateMcAggregation(data, fun = weighted.mean, w = c(.1, .9))
@@ -89,22 +95,26 @@ 
    Examples
    -

    +
    + +
    -
    + diff --git a/reference/read-ini.html b/reference/read-ini.html index 662f0c30..9588afad 100644 --- a/reference/read-ini.html +++ b/reference/read-ini.html @@ -1,65 +1,71 @@ -Read configuration options from file or API — read-ini • antaresReadRead configuration options from file or API — read-ini • antaresRead - Skip to contents + -
    -
    -
    -

    Read configuration options from file or API

    - Source: R/readIniFile.R -
    read-ini.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Read configuration options from file or API

    + Source: R/readIniFile.R +
    -
    +

    Read configuration options from file or API

    -
    -

    Usage

    + 
    readIni(pathIni, opts = antaresRead::simOptions(), default_ext = ".ini")
 
 readIniFile(file, stringsAsFactors = FALSE)
@@ -67,8 +73,8 @@ 
    Usage
 readIniAPI(study_id, path, host, token = NULL)
    -
    -

    Arguments

    +
    +

    Arguments

    pathIni

    Path to config/ini file to read.

    @@ -106,15 +112,15 @@

    Arguments -

    Value

    +
    +

    Value

    A list with an element for each section of the .ini file.

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 library(antaresRead)
 library(antaresEditObject)
@@ -135,22 +141,26 @@ 
    Examples}
    -
    +

    + +
    -
    + diff --git a/reference/readAntares.html b/reference/readAntares.html index 43adca37..c8229e07 100644 --- a/reference/readAntares.html +++ b/reference/readAntares.html @@ -1,14 +1,5 @@ -Read the data of an Antares simulation — readAntares • antaresRead - Skip to contents - - -
    -
    -
    -

    Read the data of an Antares simulation

    - Source: R/readAntares.R -
    readAntares.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Read the data of an Antares simulation

    + Source: R/readAntares.R +
    -
    +

    readAntares is a swiss-army-knife function used to read almost every possible time series of an antares Project at any desired time resolution (hourly, daily, weekly, monthly or annual).

    @@ -85,8 +83,7 @@ readLayout, readBindingConstraints)

    -
    -

    Usage

    + 
    readAntares(
   areas = NULL,
   links = NULL,
@@ -113,8 +110,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    areas

    Vector containing the names of the areas to import. If NULL no area is imported. The special value "all" tells the @@ -251,8 +248,8 @@

    Arguments -

    Value

    +
    +

    Value

    If simplify = TRUE and only one type of output is imported @@ -263,8 +260,8 @@

    Value

    -
    -

    Details

    +
    +

    Details

    If parameters areas, links, clusters and districts are all NULL, readAntares will read output for all areas. By default the function reads synthetic results if they are available.

    @@ -284,8 +281,8 @@

    DetailsmcYears). For instance one can import a random sample of 100 simulations with mcYears = sample(simOptions()$mcYears, 100)

    • -
    -

    Parallelization

    +
    +

    Parallelization

    @@ -301,14 +298,14 @@

    ParallelizationregisterDoParallel once per session.

    -
    -

    See also

    + -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 # Import areas and links separately
 
@@ -346,22 +343,26 @@ 
    Examples}
    -
    +
    + +
    - + diff --git a/reference/readAntaresAreas.html b/reference/readAntaresAreas.html index 89b68d6a..741778f5 100644 --- a/reference/readAntaresAreas.html +++ b/reference/readAntaresAreas.html @@ -1,68 +1,73 @@ -Read output for a list of areas — readAntaresAreas • antaresRead - Skip to contents + -
    -
    -
    -

    Read output for a list of areas

    - Source: R/readAntares.R -
    readAntaresAreas.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Read output for a list of areas

    + Source: R/readAntares.R +
    -
    +

    This a function is a wrapper for "antaresData" that reads all data for a list of areas.

    -
    -

    Usage

    + 
    readAntaresAreas(
   areas,
   links = TRUE,
@@ -74,8 +79,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    areas

    Vector containing area names. It represents the set of areas we are interested in. If NULL, all areas of the study are used.

    @@ -108,8 +113,8 @@

    ArgumentsreadAntares

    -
    -

    Value

    +
    +

    Value

    If simplify = TRUE and only one type of output is imported @@ -121,8 +126,8 @@

    Value

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 myarea <- simOptions()$areaList[1]
 data <- readAntaresAreas(myarea)
@@ -135,22 +140,26 @@ 
    Examples
    -
    +
    + +
    -
    + diff --git a/reference/readAntaresClusters.html b/reference/readAntaresClusters.html index 15b215eb..b1e55706 100644 --- a/reference/readAntaresClusters.html +++ b/reference/readAntaresClusters.html @@ -1,65 +1,71 @@ -Read output for a list of clusters — readAntaresClusters • antaresReadRead output for a list of clusters — readAntaresClusters • antaresRead - Skip to contents + -
    -
    -
    -

    Read output for a list of clusters

    - Source: R/readAntaresClusters.R -
    readAntaresClusters.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Read output for a list of clusters

    + Source: R/readAntaresClusters.R +
    -
    +

    Read output for a list of clusters

    -
    -

    Usage

    + 
    readAntaresClusters(
   clusters,
   selected = c("production", "NP Cost", "NODU", "profit"),
@@ -70,8 +76,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    clusters

    vector of thermal clusters to be imported

    @@ -99,29 +105,33 @@

    Arguments -

    Value

    +
    +

    Value

    data.table of results for thermal clusters

    -

    +
    + +
    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/readBindingConstraints.html b/reference/readBindingConstraints.html index 90b9c40c..3c1f1734 100644 --- a/reference/readBindingConstraints.html +++ b/reference/readBindingConstraints.html @@ -1,95 +1,97 @@ -Read binding constraints — readBindingConstraints • antaresReadRead binding constraints — readBindingConstraints • antaresRead - Skip to contents - - -
    -
    -
    -

    Read binding constraints

    - Source: R/readBindingConstraints.R -
    readBindingConstraints.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Read binding constraints

    + Source: R/readBindingConstraints.R +
    -
    +

    Antares API OK[Experimental]

    This function reads the binding constraints of an Antares project.

    Be aware that binding constraints are read in the input files of a study. So they may have changed since a simulation has been run.

    -
    -

    Usage

    + 
    readBindingConstraints(opts = simOptions())
    -
    -

    Arguments

    +
    +

    Arguments

    opts

    list of simulation parameters returned by the function setSimulationPath

    -
    -

    Value

    +
    +

    Value

    An object of class bindingConstraints. This object is also a named list with 3 sections per read constraint.

    -
    -

    Note

    +
    +

    Note

    For an study Antares version >=8.7.0. Now contains data.frame with one line per time step and \(p\) colums according to "scenarized RHS".

    For "both" case, you will find in section values two data.frame :

    • One data.frame for less

      • @@ -98,8 +100,8 @@

      Note

      Section values contains one line per time step and three columns "less", "greater" and "equal"

    -
    -

    Warning

    +
    +

    Warning

    Since release 2.7.0 the structure of the returned object has evolved for @@ -108,8 +110,8 @@

    Warning

    Values are already in section values

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 setSimulationPath()
 
@@ -134,22 +136,26 @@ 
    Examples
    -
    +
    + +
    -
    + diff --git a/reference/readClusterDesc.html b/reference/readClusterDesc.html index 4d1496d6..d6c5fe33 100644 --- a/reference/readClusterDesc.html +++ b/reference/readClusterDesc.html @@ -1,74 +1,77 @@ -Import clusters description — readClusterDesc • antaresReadImport clusters description — readClusterDesc • antaresRead - Skip to contents + -
    -
    -
    -

    Import clusters description

    - Source: R/readClusterDesc.R -
    readClusterDesc.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Import clusters description

    + Source: R/readClusterDesc.R +
    -
    +

    This function reads in the input files of an antares study the characteristics of each cluster.

    Be aware that clusters descriptions are read in the input files so they may have changed since a simulation has been run.

    -
    -

    Usage

    + 
    readClusterDesc(opts = simOptions())
 
 readClusterResDesc(opts = simOptions())
@@ -76,15 +79,15 @@ 
    Usage
 readClusterSTDesc(opts = simOptions())
    -
    -

    Arguments

    +
    +

    Arguments

    opts

    list of simulation parameters returned by the function setSimulationPath

    -
    -

    Value

    +
    +

    Value

    A data.table with one line per cluster. The columns of the data.table may @@ -124,8 +127,8 @@

    Value

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

    -
    -

    Examples

    +
    +

    Examples

    
 if (FALSE) {
 
@@ -150,22 +153,26 @@ 
    Examples
    -
    +
    + +
    -
    + diff --git a/reference/readDigestFile.html b/reference/readDigestFile.html index d0fd6e8c..e30a0876 100644 --- a/reference/readDigestFile.html +++ b/reference/readDigestFile.html @@ -1,70 +1,76 @@ -Read digest file — readDigestFile • antaresReadRead digest file — readDigestFile • antaresRead - Skip to contents + -
    -
    -
    -

    Read digest file

    - Source: R/digest.R -
    readDigestFile.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Read digest file

    + Source: R/digest.R +
    -
    +

    Read digest file

    -
    -

    Usage

    + 
    readDigestFile(opts, endpoint = "mc-all/grid/digest.txt")
    -
    -

    Arguments

    +
    +

    Arguments

    opts

    simulation options

    @@ -74,29 +80,33 @@

    Arguments

    -
    -

    Value

    +
    +

    Value

    list of 5 tables (begin, areas, middle, links lin., links quad.)

    -
    +
    + +
    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/readInputRES.html b/reference/readInputRES.html index e6974008..2c896dfa 100644 --- a/reference/readInputRES.html +++ b/reference/readInputRES.html @@ -1,71 +1,75 @@ -Read Input RES time series — readInputRES • antaresRead - Skip to contents - - -
    -
    -
    -

    Read Input RES time series

    - Source: R/readInputClusters.R -
    readInputRES.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Read Input RES time series

    + Source: R/readInputClusters.R +
    -
    +

    readInputRes is a function that reads renewable time series from an antares project. But contrary to readAntares, it only reads time series stored in the input folder, so it can work in "input" mode.

    -
    -

    Usage

    + 
    readInputRES(
   clusters = NULL,
   opts = simOptions(),
@@ -76,8 +80,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    clusters

    vector of RES clusters names for which renewable time series must be read.

    @@ -107,34 +111,38 @@

    Arguments -

    Value

    +
    +

    Value

    data.table with class "antaresDataTable".

    -
    -

    See also

    + -
    +

    + +
    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/readInputTS.html b/reference/readInputTS.html index 631ae8dd..02ea6485 100644 --- a/reference/readInputTS.html +++ b/reference/readInputTS.html @@ -1,74 +1,77 @@ -Read Input time series — readInputTS • antaresRead - Skip to contents + -
    -
    -
    -

    Read Input time series

    - Source: R/readInputTS.R -
    readInputTS.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Read Input time series

    + Source: R/readInputTS.R +
    -
    +

    Antares API OK

    readInputTS is a function that reads time series from an antares project. But contrary to readAntares, it only reads time series stored in the input folder, so it can work in "input" mode.

    -
    -

    Usage

    + 
    readInputTS(
   load = NULL,
   thermalAvailabilities = NULL,
@@ -91,8 +94,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    load

    vector of areas names for which load time series must be read.

    @@ -171,8 +174,8 @@

    Arguments -

    Value

    +
    +

    Value

    If simplify = TRUE and only one type of input is imported @@ -183,20 +186,20 @@

    Value

    -
    -

    Note

    +
    +

    Note

    All parameters expecting a vector of areas or links names also accept the special value "all". It indicates the function to read the desired time series for all areas or links.

    -
    -

    See also

    + -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 # Set an antares study in "input" mode. This is useful when one want to
 # inspect input time series before running a simulation.
@@ -220,22 +223,26 @@ 
    Examples
    -
    +
    + +
    -

    + diff --git a/reference/readInputThermal.html b/reference/readInputThermal.html index db8d9ead..865769a7 100644 --- a/reference/readInputThermal.html +++ b/reference/readInputThermal.html @@ -1,71 +1,75 @@ -Read Input thermal time series — readInputThermal • antaresRead - Skip to contents - - -
    -
    -
    -

    Read Input thermal time series

    - Source: R/readInputClusters.R -
    readInputThermal.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Read Input thermal time series

    + Source: R/readInputClusters.R +
    -
    +

    readInputThermal is a function that reads thermal time series from an antares project. But contrary to readAntares, it only reads time series stored in the input folder, so it can work in "input" mode.

    -
    -

    Usage

    + 
    readInputThermal(
   clusters = NULL,
   thermalModulation = FALSE,
@@ -78,8 +82,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    clusters

    vector of clusters names for which thermal time series must be read.

    @@ -117,8 +121,8 @@

    Arguments -

    Value

    +
    +

    Value

    If thermalModulation or thermalData is TRUE, an object of class "antaresDataList" is returned. It is a list of @@ -127,33 +131,37 @@

    Value

    Else the result is a data.table with class "antaresDataTable".

    -
    -

    Note

    +
    +

    Note

    the clusters parameter can also accept the special value "all". It indicates the function to read the desired time series for all clusters.

    -
    -

    See also

    + -
    +
    + +

    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/readLayout.html b/reference/readLayout.html index c1d0a794..741e6a44 100644 --- a/reference/readLayout.html +++ b/reference/readLayout.html @@ -1,68 +1,71 @@ -Read areas layout — readLayout • antaresReadRead areas layout — readLayout • antaresRead - Skip to contents - - -
    -
    -
    -

    Read areas layout

    - Source: R/readLayout.R -
    readLayout.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Read areas layout

    + Source: R/readLayout.R +
    -
    +

    This function reads in the input files of an antares study the current areas layout, ie. the position of the areas It may be useful for plotting the network.

    @@ -70,13 +73,12 @@ changed since a simulation has been run.

    -
    -

    Usage

    + 
    readLayout(opts = simOptions(), xyCompare = c("union", "intersect"))
    -
    -

    Arguments

    +
    +

    Arguments

    opts

    list of simulation parameters returned by the function setSimulationPath

    @@ -86,8 +88,8 @@

    Arguments

    -
    -

    Value

    +
    +

    Value

    A list with three elements:

    @@ -109,8 +111,8 @@

    Value

    opts. And we can pass multiple studies using a list of opts.

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 readLayout()
 
@@ -126,22 +128,26 @@ 
    Examples
    -
    +
    + +
    -
    + diff --git a/reference/readOptimCriteria.html b/reference/readOptimCriteria.html index 0c7b44e8..3a4ec6d4 100644 --- a/reference/readOptimCriteria.html +++ b/reference/readOptimCriteria.html @@ -1,83 +1,87 @@ -Read Optimization Criteria — readOptimCriteria • antaresRead - Skip to contents - - -
    -
    -
    -

    Read Optimization Criteria

    - Source: R/read_optim_criteria.R -
    readOptimCriteria.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Read Optimization Criteria

    + Source: R/read_optim_criteria.R +
    -
    +

    This function can be used to read the value of the criteria optimized by ANTARES. Notice that these values are only available in "Xpansion" mode or when option "Export mps" is turned on.

    -
    -

    Usage

    + 
    readOptimCriteria(opts = simOptions())
    -
    -

    Arguments

    +
    +

    Arguments

    opts

    list of simulation parameters returned by the function setSimulationPath

    -
    -

    Value

    +
    +

    Value

    A table of class antaresDataTable. It contains the usual columns @@ -86,8 +90,8 @@

    Value

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 setSimulationPath()
 
@@ -96,22 +100,26 @@ 
    Examples
    -
    +
    + +
    -
    + diff --git a/reference/removeVirtualAreas.html b/reference/removeVirtualAreas.html index 621efbe0..43f46528 100644 --- a/reference/removeVirtualAreas.html +++ b/reference/removeVirtualAreas.html @@ -1,71 +1,75 @@ -Remove virtual areas — removeVirtualAreas • antaresReadRemove virtual areas — removeVirtualAreas • antaresRead - Skip to contents - - -
    -
    -
    -

    Remove virtual areas

    - Source: R/removeVirtualAreas.R -
    removeVirtualAreas.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Remove virtual areas

    + Source: R/removeVirtualAreas.R +
    -
    +

    This function removes virtual areas from an antaresDataList object and corrects the data for the real areas. The antaresDataList object should contain area and link data to function correctly.

    -
    -

    Usage

    + 
    removeVirtualAreas(
   x,
   storageFlexibility = NULL,
@@ -79,8 +83,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    x

    An object of class antaresDataList with at least components areas and links.

    @@ -132,16 +136,16 @@

    Arguments

    -
    -

    Value

    +
    +

    Value

    An antaresDataList object in which virtual areas have been removed and data of the real has been corrected. See details for an explanation of the corrections.

    -
    -

    Details

    +
    +

    Details

    Two types of virtual areas have been defined corresponding to different types of modeling in Antares and different types of post-treatment to do:

    • Flexibility/storage areas are areas created to model @@ -195,8 +199,8 @@

      Details

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 
 # Assume we have a network with two virtual areas acting as pump storage and
@@ -236,22 +240,26 @@ 
    Examples
    -
    +
    + +
    -
    + diff --git a/reference/setAlias.html b/reference/setAlias.html index d866a840..3a09e785 100644 --- a/reference/setAlias.html +++ b/reference/setAlias.html @@ -1,12 +1,5 @@ -show aliases for variables — showAliases • antaresReadshow aliases for variables — showAliases • antaresRead - Skip to contents + -
    -
    -
    -

    show aliases for variables

    - Source: R/showAliases.R -
    setAlias.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    show aliases for variables

    + Source: R/showAliases.R +
    -
    +

    Aliases are short names that can be used in the select parameter in function readAntares to tell the function which columns and/or type of data to import.

    @@ -79,8 +79,7 @@

    showAliases lists available aliases

    -
    -

    Usage

    + 
    showAliases(names = NULL)
 
 setAlias(name, desc, select)
@@ -88,8 +87,8 @@ 
    Usage
 getAlias(name)
    -
    -

    Arguments

    +
    +

    Arguments

    names

    optional vector of alias names. If provided, the full list of columns selected by these aliases is displayed. Else only the name and a @@ -109,8 +108,8 @@

    Arguments -

    Value

    +
    +

    Value

    setAlias is only used for its side effects. A data.frame with columns @@ -118,8 +117,8 @@

    Value

    -
    -

    Examples

    +
    +

    Examples

    
 # Display the short description of an alias
 showAliases()
@@ -155,22 +154,26 @@ 
    Examples
    -
    +

    + +
    -
    + diff --git a/reference/setHvdcAreas.html b/reference/setHvdcAreas.html index 0badeeb4..b2bd4e11 100644 --- a/reference/setHvdcAreas.html +++ b/reference/setHvdcAreas.html @@ -1,70 +1,76 @@ -Set hvdc areas — setHvdcAreas • antaresReadSet hvdc areas — setHvdcAreas • antaresRead - Skip to contents + -
    -
    -
    -

    Set hvdc areas

    - Source: R/setHvdcAreas.R -
    setHvdcAreas.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Set hvdc areas

    + Source: R/setHvdcAreas.R +
    -
    +

    This function add hvdc attribute

    -
    -

    Usage

    + 
    setHvdcAreas(data, areas)
    -
    -

    Arguments

    +
    +

    Arguments

    data

    antaresData or antaresDatalist data.

    @@ -73,15 +79,15 @@

    Arguments -

    Value

    +
    +

    Value

    A list with three elements:

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 
 library(antaresRead)
@@ -94,22 +100,26 @@ 
    Examples
    -
    +

    + +
    -
    + diff --git a/reference/setRam.html b/reference/setRam.html index cb80806a..47473087 100644 --- a/reference/setRam.html +++ b/reference/setRam.html @@ -1,77 +1,83 @@ -Specify RAM limit — setRam • antaresReadSpecify RAM limit — setRam • antaresRead - Skip to contents + -
    -
    -
    -

    Specify RAM limit

    - Source: R/giveSize.R -
    setRam.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Specify RAM limit

    + Source: R/giveSize.R +
    -
    +

    This function specify RAM limit (in Go) of the value returned by readAntares.

    -
    -

    Usage

    + 
    setRam(x)
    -
    -

    Arguments

    +
    +

    Arguments

    x

    numeric RAM limit in Go

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 #Set maximum ram to used to 50 Go
 setRam(50)
@@ -79,22 +85,26 @@ 
    Examples
    -
    +
    + +
    -
    + diff --git a/reference/setSimulationPath.html b/reference/setSimulationPath.html index 92a42ca6..109933b3 100644 --- a/reference/setSimulationPath.html +++ b/reference/setSimulationPath.html @@ -1,74 +1,77 @@ -Set Path to an Antares simulation — setSimulationPath • antaresReadSet Path to an Antares simulation — setSimulationPath • antaresRead - Skip to contents + -
    -
    -
    -

    Set Path to an Antares simulation

    - Source: R/setSimulationPath.R, R/utils_api.R -
    setSimulationPath.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Set Path to an Antares simulation

    + Source: R/setSimulationPath.R, R/utils_api.R +
    -
    +

    This function has to be used before the read functions. It sets the path to the Antares simulation to work on and other useful options (list of areas, links, areas with clusters, variables, etc.). On local disk with setSimulationPath or on an AntaREST API with setSimulationPathAPI

    -
    -

    Usage

    + 
    setSimulationPath(path, simulation = NULL)
 
 setSimulationPathAPI(
@@ -81,8 +84,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    path

    (optional) Path to the simulation. It can either be the path to a directory containing @@ -122,8 +125,8 @@

    Argumentsconfig

    -
    -

    Value

    +
    +

    Value

    A list containing various information about the simulation, in particular:

    @@ -208,8 +211,8 @@

    Value

    timer for api commande execute

    -
    -

    Details

    +
    +

    Details

    The simulation chosen with setSimulationPath or setSimulationPathAPI becomes the default simulation for all functions of the package. This behavior is fine when working on only one simulation, but it may become problematic when working @@ -217,14 +220,14 @@

    DetailsIn such case, you can store the object returned by the function in a variable and pass this variable to the functions of the package (see examples).

    -
    -

    See also

    + -
    -

    Examples

    +
    +

    Examples

    
 if (FALSE) {
 # Select interactively a study. It only works on windows.
@@ -325,22 +328,26 @@ 
    Examples
    -
    +
    + +
    -
    + diff --git a/reference/setTimeoutAPI.html b/reference/setTimeoutAPI.html index 028090ce..6563f400 100644 --- a/reference/setTimeoutAPI.html +++ b/reference/setTimeoutAPI.html @@ -1,70 +1,76 @@ -Change API Timeout — setTimeoutAPI • antaresReadChange API Timeout — setTimeoutAPI • antaresRead - Skip to contents + -
    -
    -
    -

    Change API Timeout

    - Source: R/utils_api.R -
    setTimeoutAPI.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Change API Timeout

    + Source: R/utils_api.R +
    -
    +

    Change API Timeout

    -
    -

    Usage

    + 
    setTimeoutAPI(opts, timeout)
    -
    -

    Arguments

    +
    +

    Arguments

    opts

    list of simulation parameters returned by the function setSimulationPathAPI

    @@ -75,30 +81,34 @@

    Arguments -

    Examples

    +
    +

    Examples

    if (FALSE) {
 opts <- setTimeoutAPI(opts, timeout = 45)
 }
    -

    +
    + +
    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/simOptions.html b/reference/simOptions.html index 3046d9bf..00a1cded 100644 --- a/reference/simOptions.html +++ b/reference/simOptions.html @@ -1,82 +1,86 @@ -Extract simulation options — simOptions • antaresReadExtract simulation options — simOptions • antaresRead - Skip to contents - - -
    -
    -
    -

    Extract simulation options

    - Source: R/simOptions.R -
    simOptions.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Extract simulation options

    + Source: R/simOptions.R +
    -
    +

    The function readAntares stores in its output the options used to read some data (path of the study, area list, link list, start date, etc.).

    -
    -

    Usage

    + 
    simOptions(x = NULL)
    -
    -

    Arguments

    +
    +

    Arguments

    x

    object of class antaresTable or antaresData

    -
    -

    Value

    +
    +

    Value

    list of options used to read the data contained in an object or the last @@ -85,8 +89,8 @@

    Value

    -
    -

    Details

    +
    +

    Details

    simOptions extracts these options from an object of class antaresTable or antaresOutput. It can be useful when working on multiple simulations, either to check how some object has been created or to @@ -97,8 +101,8 @@

    Details

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
   setSimulationPath(study1)
   
@@ -118,22 +122,26 @@ 
    Examples
    -
    +
    + +
    -
    + diff --git a/reference/subset.antaresDataList.html b/reference/subset.antaresDataList.html index 5028de78..1f5a656d 100644 --- a/reference/subset.antaresDataList.html +++ b/reference/subset.antaresDataList.html @@ -1,71 +1,77 @@ -Subset an antaresDataList — subset.antaresDataList • antaresReadSubset an antaresDataList — subset.antaresDataList • antaresRead - Skip to contents + -
    -
    -
    -

    Subset an antaresDataList

    - Source: R/subset.R -
    subset.antaresDataList.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Subset an antaresDataList

    + Source: R/subset.R +
    -
    +

    Subset method for antaresDataList.

    -
    -

    Usage

    + 
    # S3 method for antaresDataList
 subset(x, y = NULL, areas = NULL, timeIds = NULL, mcYears = NULL, ...)
    -
    -

    Arguments

    +
    +

    Arguments

    x

    Object of class antaresDataList created with readAntares.

    @@ -96,15 +102,15 @@

    Arguments -

    Value

    +
    +

    Value

    A filtered antaresDataList.

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 #keep only the first year
 mydata <- readAntares(areas = "all", links = "all", mcYears = "all")
@@ -122,22 +128,26 @@ 
    Examples
    -
    +

    + +
    -
    + diff --git a/reference/summary.bindingConstraints.html b/reference/summary.bindingConstraints.html index 6b8e5cc5..20e9179e 100644 --- a/reference/summary.bindingConstraints.html +++ b/reference/summary.bindingConstraints.html @@ -1,74 +1,79 @@ -Display equation of binding constraint — summary.bindingConstraints • antaresReadDisplay equation of binding constraint — summary.bindingConstraints • antaresRead - Skip to contents + -
    -
    -
    -

    Display equation of binding constraint

    - Source: R/readBindingConstraints.R -
    summary.bindingConstraints.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Display equation of binding constraint

    + Source: R/readBindingConstraints.R +
    -
    +

    [Deprecated] This function cannot be used for a study >= 8.7.0

    -
    -

    Usage

    + 
    # S3 method for bindingConstraints
 summary(object, ...)
    -
    -

    Arguments

    +
    +

    Arguments

    object

    Object returned by readBindingConstraints

    @@ -77,29 +82,33 @@

    Arguments -

    Value

    +
    +

    Value

    A data.frame with one line per constraint.

    -

    +
    + +
    -
    +

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

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/viewAntares.html b/reference/viewAntares.html index 4fc8c248..46028d6d 100644 --- a/reference/viewAntares.html +++ b/reference/viewAntares.html @@ -1,73 +1,78 @@ -View the content of an antares output — viewAntares • antaresReadView the content of an antares output — viewAntares • antaresRead - Skip to contents + -
    -
    -
    -

    View the content of an antares output

    - Source: R/viewAntares.R -
    viewAntares.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    View the content of an antares output

    + Source: R/viewAntares.R +
    -
    +

    This function displays each element of an antaresData object in a spreadsheet-like viewer.

    -
    -

    Usage

    + 
    viewAntares(x, ...)
    -
    -

    Arguments

    +
    +

    Arguments

    x

    An object of class antaresData, generated by the function readAntares.

    @@ -77,15 +82,15 @@

    Arguments -

    Value

    +
    +

    Value

    Invisible NULL.

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 setSimulationPath()
 
@@ -98,22 +103,26 @@ 
    Examples
    -
    +

    + +
    -
    + diff --git a/reference/writeAntaresH5.html b/reference/writeAntaresH5.html index 579b905c..055c92ad 100644 --- a/reference/writeAntaresH5.html +++ b/reference/writeAntaresH5.html @@ -1,65 +1,71 @@ -Convert antares output to h5 file — writeAntaresH5 • antaresReadConvert antares output to h5 file — writeAntaresH5 • antaresRead - Skip to contents + -
    -
    -
    -

    Convert antares output to h5 file

    - Source: R/h5_writeH5ByYear.R -
    writeAntaresH5.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Convert antares output to h5 file

    + Source: R/h5_writeH5ByYear.R +
    -
    +

    Convert antares output to h5 file

    -
    -

    Usage

    + 
    writeAntaresH5(
   path = NULL,
   timeSteps = c("hourly", "daily", "weekly", "monthly", "annual"),
@@ -87,8 +93,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    path

    character folder where h5 file will be write (default NULL)

    @@ -183,8 +189,8 @@

    Arguments -

    Examples

    +
    +

    Examples

    
 if (FALSE) {
 # Write simulation one by one
@@ -232,22 +238,26 @@ 
    Examples}
    -

    +
    + +
    -
    + diff --git a/reference/writeDigest.html b/reference/writeDigest.html index 67f3c6f4..811fdf12 100644 --- a/reference/writeDigest.html +++ b/reference/writeDigest.html @@ -1,70 +1,76 @@ -Write digest file — writeDigest • antaresReadWrite digest file — writeDigest • antaresRead - Skip to contents + -
    -
    -
    -

    Write digest file

    - Source: R/digest.R -
    writeDigest.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Write digest file

    + Source: R/digest.R +
    -
    +

    Write digest file

    -
    -

    Usage

    + 
    writeDigest(digest, opts = simOptions())
    -
    -

    Arguments

    +
    +

    Arguments

    digest

    list of 5 elements similar to what is returned by readDigestFile

    @@ -73,34 +79,38 @@

    Arguments -

    Value

    +
    +

    Value

    updated digest list of 5 tables (begin, areas, middle, links lin., links quad.)

    -
    -

    See also

    +
    +

    See also

    readDigestFile

    -
    +

    + +
    -
    +