https://github.com/rte-antares-rpackage/antaresvizmedtso
https://github.com/rte-antares-rpackage/antaresvizmedtso
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rte-antares-rpackage/antaresvizmedtso
- Owner: rte-antares-rpackage
- Created: 2019-04-23T08:52:49.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-04-25T06:38:07.000Z (about 3 years ago)
- Last Synced: 2025-01-31T06:48:01.481Z (5 months ago)
- Language: R
- Size: 6.59 MB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://cran.r-project.org/package=antaresViz)
[](https://travis-ci.org/rte-antares-rpackage/antaresViz)
[](https://ci.appveyor.com/project/rte-antares-rpackage/antaresViz)[](https://codecov.io/gh/rte-antares-rpackage/antaresViz)
# The package antaresVizMedTSO : visualize the results of an Antares simulation for Med-TSO
`antaresVizMedTSO` is the package to visualize the results of your Antares simulations that you have imported in the R session with package `antaresRead`. It provides some functions that generate interactive visualisations. Moreover, by default, these functions launch a shiny widget that provides some controls to dynamically choose what data is displayed in the graphics.
## Installation
Install from clean session :
```r
rm(list = ls())
lapply(paste('package:',names(sessionInfo()$otherPkgs),sep=""),detach,character.only=TRUE,unload=TRUE)
.rs.restartR( )
````
Needed for moment specific ``spMaps`` package version :
```r
if(!require(devtools)){
install.packages("devtools")
require(devtools)
}
Sys.setenv(R_REMOTES_NO_ERRORS_FROM_WARNINGS="true")
devtools::install_github("rte-antares-rpackage/spMaps", ref = "med-tso")
```
Then install the master version of ``antaresVizMedTSO`` :
```r
if(!require(devtools)){
install.packages("devtools")
require(devtools)
}
Sys.setenv(R_REMOTES_NO_ERRORS_FROM_WARNINGS="true")
devtools::install_github("rte-antares-rpackage/antaresVizMedTSO", ref ="master")
```
To display the help of the package and see all the functions it provides, type:
```r
help(package="antaresVizMedTSO")
```
## All-in-one Application
```r
antaresVizMedTSO::runAppAntaresViz()
```
## Basic plots
`antaresVizMedTSO` provides a plot method for tables generated with `antaresRead`. This method is for visualizing a single variable in different formats (times series, barplot, monotone, distribution and cumulative distribution). For instance, the following code displays the distribution of marginal price in different areas.
```
mydata <- readAntares(areas = "all")
plot(mydata, variable = "MRG. PRICE")
```
For more information, run:
```r
?plot.antaresDataTable
```
## Stacks
Function `prodStack` generates a production stack for a set of areas. Different stacks have been defined. One can see their definition with command `productionStackAliases()`.
With function `exchangesStack`, one can visualize the evolution and origin/destination of imports and exports for a given area.
## Maps
The construction of maps first requires to associate geographic coordinates to the areas of a study. antaresViz provides function `mapLayout` to do interactively this association.
```r
# Get the coordinates of the areas as they have been placed in the antaresSoftware
layout <- readLayout()
# Associate geographical coordinates
myMapLayout <- mapLayout(layout)
# This mapping should be done once and the result be saved on disk.
save(myMapLayout, file = "myMapLayout.rda")
```
Then map can be generated with function `plotMap`:
```r
myData <- readAntares(areas = "all", links = "all")
plotMap(myData, myMapLayout)
```
You can use `spMaps` to set a map background or download some files at http://www.gadm.org/country.
## Contributing:
Contributions to the library are welcome and can be submitted in the form of pull requests to this repository.
## ANTARES :
Antares is a powerful software developed by RTE to simulate and study electric power systems (more information about Antares here : ).
ANTARES is now an open-source project (since 2018), you can download the sources [here](https://github.com/AntaresSimulatorTeam/Antares_Simulator) if you want to use this package.
## License Information:
Copyright 2015-2016 RTE (France)
* RTE: http://www.rte-france.com
This Source Code is subject to the terms of the GNU General Public License, version 2 or any higher version. If a copy of the GPL-v2 was not distributed with this file, You can obtain one at https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html.