Package: antaresRead 3.0.2.9000

Tatiana Vargas

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

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/>).

Authors:Tatiana Vargas [aut, cre], Jalal-Edine ZAWAM [aut], Frederic Breant [ctb], Francois Guillem [aut], Benoit Thieurmel [aut], Titouan Robert [aut], Victor Perrier [ctb], Etienne Sanchez [ctb], Assil Mansouri [ctb], Clement Berthet [ctb], Kamel Kemiha [ctb], Abdallah Mahoudi [ctb], Nicolas Boitard [ctb], RTE [cph]

antaresRead_3.0.2.9000.tar.gz
antaresRead_3.0.2.9000.zip(r-4.7)antaresRead_3.0.2.9000.zip(r-4.6)antaresRead_3.0.2.9000.zip(r-4.5)
antaresRead_3.0.2.9000.tgz(r-4.6-any)antaresRead_3.0.2.9000.tgz(r-4.5-any)
antaresRead_3.0.2.9000.tar.gz(r-4.7-any)antaresRead_3.0.2.9000.tar.gz(r-4.6-any)
antaresRead_3.0.2.9000.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
antaresRead/json (API)

# Install 'antaresRead' in R:

install.packages('antaresRead', repos = c('https://rte-antares-rpackage.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/rte-antares-rpackage/antaresread/issues

Pkgdown/docs site:https://rte-antares-rpackage.github.io

On CRAN:

infrastructure dataimport adequacy bilan electricity energy hdf5 linear-algebra monte-carlo-simulation optimisation previsionnel rhdf5 rte simulation tyndp

9.40 score 14 stars 3 packages 123 scripts 910 downloads 51 exports 56 dependencies

Last updated from:23084899d6. Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel-x86_64	OK	199
source / vignettes	OK	221
linux-release-x86_64	OK	254
macos-release-arm64	OK	162
macos-oldrel-arm64	OK	163
windows-devel	OK	176
windows-release	OK	192
windows-oldrel	OK	185
wasm-release	OK	160

Exports:aggregateResult api_delete api_get api_post api_put as.antaresDataList as.antaresDataTable changeTimeStep copyToClipboard extractDataList getAlias getAreas getDistricts getGeographicTrimming getIdCols getLinks getThematicTrimming hvdcModification list_thematic_variables mergeDigests parAggregateMCall ponderateMcAggregation read_storages_constraints readAntares readAntaresAreas readAntaresClusters readAntaresSTClusters readBindingConstraints readClusterDesc readClusterResDesc readClusterSTDesc readDigestFile readIni readIniAPI readIniFile readInputRES readInputThermal readInputTS readLayout readOptimCriteria removeVirtualAreas setAlias setHvdcAreas setRam setSimulationPath setSimulationPathAPI setTimeoutAPI showAliases simOptions viewAntares writeDigest

Dependencies:arrow askpass assertthat base64enc bit bit64 bslib cachem cli codetools commonmark cpp11 curl data.table digest doParallel fastmap fontawesome foreach fs generics glue htmltools httpuv httr iterators jquerylib jsonlite later lifecycle lubridate magrittr memoise memuse mime openssl otel pbapply plyr promises purrr R6 rappdirs Rcpp rlang sass shiny sourcetools stringi stringr sys tidyselect timechange vctrs withr xtable

The 'antaresRead' Package

Installation | Before reading data | Reading time series | Manipulating data | Other useful functions

Rendered fromantaresRead.Rmdusingknitr::rmarkdown

Last update: 2020-02-21
Started: 2020-02-21

Help page	Topics
Retrieve information on a file's state of preparation and retrieve download file.	.download_api_aggregate_result
Filter a list of binding constraints by names by a exact match	.filter_bindingConstraints_by_names
API methods	API-methods api_delete api_get api_post api_put
Convert objects to antaresDataTable	as.antaresDataList as.antaresDataList.antaresDataTable as.antaresDataList.data.frame
Convert objects to antaresDataTable	as.antaresDataTable as.antaresDataTable.data.frame
Change the timestep of an output	changeTimeStep
Copy data to the clipboard	copyToClipboard copyToClipboard.antaresDataList
Format data PPSE-style	extractDataList
Select and exclude areas	getAreas getDistricts
Read geographic trimming (filtering) options	getGeographicTrimming
get Id columns	getIdCols
Retrieve links connected to a set of areas	getLinks
Get the Thematic trimming of an Antares study	getThematicTrimming
hvdc straitement	hvdcModification
List of thematic trimming variables available according to study version	list_thematic_variables
Merge two digests	mergeDigests
Creation of Mc_all new (only antares > V6)	aggregateResult parAggregateMCall
Mcyear aggregation weigthed by wd	ponderateMcAggregation
Read Short-term storages / additional constraints	read_storages_constraints
Read configuration options from file or API	read-ini readIni readIniAPI readIniFile
Read the data of an Antares simulation	readAntares
Read output for a list of areas	readAntaresAreas
Read output for a list of clusters	readAntaresClusters
Read output for a list of short-term storage clusters	readAntaresSTClusters
Read binding constraints	readBindingConstraints
Import clusters description	readClusterDesc readClusterResDesc readClusterSTDesc
Read digest file	readDigestFile
Read Input RES time series	readInputRES
Read Input thermal time series	readInputThermal
Read Input time series	readInputTS
Read areas layout	readLayout
Read Optimization Criteria	readOptimCriteria
Remove virtual areas	removeVirtualAreas
Set hvdc areas	setHvdcAreas
Specify RAM limit	setRam
Set Path to an Antares simulation	setSimulationPath setSimulationPathAPI
Change API Timeout	setTimeoutAPI
show aliases for variables	getAlias setAlias showAliases
Extract simulation options	simOptions
Subset an antaresDataList	subset.antaresDataList
Display equation of binding constraint	summary.bindingConstraints
View the content of an antares output	viewAntares
Write digest file	writeDigest

Package: antaresRead 3.0.2.9000

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

Citation

Development and contributors

Readme and manuals

Help Manual

Usage by other packages (reverse dependencies)