R Observatory: Metrics for antaresRead version 3.1.0

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

antaresRead

3.1.0Package record

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

3packages depend

10.1Kdownloads / year

59.0%test coverage

8/13flavors OK

Overview

About

Maintained by Tatiana VargasCRAN page ↗GitHub ↗Website ↗Issues ↗

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

Changes in 3.1.0

ENHANCEMENT :

.getPathsAPI() uses a specific endpoint to get the list of the outputs of a study.

BUGFIXES :

.getSimOptionsAPI() reads and returns the new converted study version format (ex : 9.0 => 900) in output mode

BREAKING CHANGES :

.getInputOptionsAPI() Since Antares Web 2.33.0, new numbering system in API mode (ex : 7.0, 8.2, 9.2, ...)

From NEWS.md in the release

Install

R (CRAN)pak (dev)Ubuntu (r2u)Fedora (COPR)openSUSE (OBS)

install.packages("antaresRead", repos = "https://cloud.r-project.org/")

Installs the current CRAN release. Prebuilt binaries on Windows and macOS.

if (!requireNamespace("pak", quietly = TRUE))
  install.packages("pak", repos = "https://cloud.r-project.org/")
pak::pak("rte-antares-rpackage/antaresRead")

Development version from rte-antares-rpackage/antaresRead. Installs pak first if it is not already available.

Release

# enable cranapt (r2u) if it is not already set up, then install
grep -rqs r2u.stat.illinois.edu /etc/apt/sources.list /etc/apt/sources.list.d/ \
  || curl -fsSL https://raw.githubusercontent.com/eddelbuettel/r2u/master/inst/scripts/add_cranapt_noble.sh | sudo bash
sudo apt install -y r-cran-antaresread

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled. We list this channel from recorded r2u download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

bspm (used by r2u) also needs make: sudo apt install make

# enable the iucar/cran COPR if it is not already present, then install
ls /etc/yum.repos.d/*iucar*cran*.repo >/dev/null 2>&1 \
  || sudo dnf copr enable -y iucar/cran
sudo dnf install -y R-CRAN-antaresRead

RPMs from the iucar/cran COPR, rebuilt from CRAN.

For install.packages() integration in R, also: sudo dnf install R-CoprManager

# add the autoCRAN OBS repo (Tumbleweed) if it is missing, then install
zypper -q lr | grep -qi autoCRAN \
  || sudo zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/R:/autoCRAN/openSUSE_Tumbleweed/devel:languages:R:autoCRAN.repo
sudo zypper install -y R-antaresRead

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed). We list this channel from recorded autoCRAN download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

Health

CRAN checks

5NOTE8OK

Check messages

NOTEdependencies in R coder-devel-linux-x86_64-debian-clang, r-devel-linux-x86_64-debian-gcc, r-devel-linux-x86_64-fedora-clang, r-devel-linux-x86_64-fedora-gcc, r-devel-windows-x86_64

r-devel-linux-x86_64-debian-clang, r-devel-linux-x86_64-debian-gcc, r-devel-linux-x86_64-fedora-clang, r-devel-linux-x86_64-fedora-gcc

Base package in Suggests/Enhances imported in NAMESPACE:
  ‘parallel’

r-devel-windows-x86_64

Base package in Suggests/Enhances imported in NAMESPACE:
  'parallel'

CRAN check page ↗

Slowest check: 5.9 min · r-oldrel-windows-x86_64

Status changes

NOTE8 OK, 5 NOTENow
NOTE11 OK, 2 NOTE2026-09-12
OK13 OK2026-09-08
ERROR12 OK, 1 ERROR2026-09-07
OK13 OK2026-08-05
NOTE12 OK, 1 NOTE2026-08-01

Show 3 earlier changesHide 3 earlier changes

OK13 OK2026-06-12
ERROR12 OK, 1 ERROR2026-06-07
OK14 OK2026-03-10

Advisories

none known

How this is measured·How advisories are found

Documentation

In release 3.1.0

README· In the repository, left out of the releaseVignettesYes · 1 · staticNEWSYes · 67% structured · mentions 3.1.0Citation fileNoWebsiteYes · pkgdown

Help pages: 46 (3 internal)includes a package overview page
Examples that run: 4%1 run in a plain check · 26 never run
Exported functions with examples: 64%
Documented parameters: 100%
Return-value docs: 100%
Help pages citing references: 0%

Vignettes (1)

The 'antaresRead' Package HTML

How these are measured

Downloads

10.1K

CRAN downloads in the past year

Rank #3,972 · ~28/day · ~838/mo

Releases R versions

Daily download trend is not available in this view yet.

81530 days

2.3K90 days

10.1K1 year

Compare downloads with other packages →

Also on431 r2u19 autocran

How downloads are counted

Repository

rte-antares-rpackage/antaresread ↗Organization: rte-antares-rpackage

14Stars

7Forks

6Open issues

2Open PRs

27Releases

1,078Commits

28Commit identities

rmonte-carlo-simulationoptimisationsimulationlinear-algebraenergyelectricityadequacy

1,078 commits · Last activity 2026-09-16 · 0% stars, 30d · Default branch at 3.1.1.9000, ahead of CRAN 3.1.0 (checked 2026-10-21)

Responsiveness

How these are sampled

PRs merged (all time): 88%
Median days to close, 50 most recently updated closed issues: 186
Median days to close, 50 most recently updated closed PRs: 0

Stars over time

2024-08-23 · 132026-07-07 · 14

How these are measured

PracticesBeta

8 development-tooling and community-health practices detected across 4 families in the upstream repository

Checks run against github.com/rte-antares-rpackage/antaresread on 2026-10-21.

Continuous integration (2)

GitHub ActionsR CMD check workflow

The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel

Docs source (3)

pkgdown

GitHub Pages site last deployed 2026-09-16 · The repository has a site deploy workflow

Coverage (1)

Coverage reporting (Codecov)

CRAN release process (2)

cran-comments.mdrevdep/

How this is detected·Detection ruleset v4 (2026-10-20)

Dependencies

Declared dependencies

22 external dependencies (excludes base and recommended)

Installing antaresRead adds 55 packages (35 with compiled code, 53 MB of source tarballs). Heaviest: stringi 11 MB, data.table 5.7 MB, bslib 5.6 MB.

Depends (0)

none

Imports (19)

data.table bit64 lubridate plyrmethodsstatsstringr stringi shiny pbapply doParallel jsonlite httrutilsmemuse purrr lifecycle assertthat arrow

LinkingTo (0)

none

Suggests (7)

testthat covr knitr rmarkdown foreachparallelhtmltools

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

3direct

0indirect

Depends 3

Depends, Imports or LinkingTo, most downloaded first

antaresEditObject antaresViz antaresProcessing

How these are counted

Code & Tests

People & History

People (14)

Tatiana Vargas

Author, Maintainer since 2.6.0 (2023) · added in 2.6.0

Francois Guillem

Author

Titouan Robert

Author · added in 2.0.0

Benoit Thieurmel

Author · added in 2.0.0

Jalal-Edine ZAWAM

Author

Clement Berthet

Contributor · added in 2.6.0

Nicolas Boitard

Contributor · added in 2.7.1

Frederic Breant

Contributor · added in 2.2.2

Kamel Kemiha

Contributor · added in 2.6.1

Abdallah Mahoudi

Contributor · added in 2.6.1

Assil Mansouri

Contributor · added in 2.4.2

Victor Perrier

Contributor · added in 2.2.4

Etienne Sanchez

Contributor · added in 2.2.5

RTE

Copyright holder

Previously maintained by Veronique Bachelier (2.2.4 to 2.5.1) and Frederic Breant (2.2.2 to 2.2.3).

Listed in earlier versions (1)

Veronique Bachelier

no longer listed · 2.2.4 to 2.5.1

Releases (37)

Pick two releases to compare their code metrics.

3.1.0Latest
record
2026-05-28 · current release · diff ↗
3.0.1
record
2026-05-28 · diff ↗
R
R 4.6.0 released · 2026-04-24
3.0.0
record
2026-01-28 · diff ↗
2.9.3
record
2025-11-06 · diff ↗
2.9.2
record
2025-09-23 · diff ↗ ·
added 3 exports
getThematicTrimming, list_thematic_variables, read_storages_constraints
R
R 4.5.0 released · 2025-04-11
2.9.0
record
2025-02-11 · diff ↗
2.7.2
record
2024-09-12 · diff ↗ ·
added 1 export
readAntaresSTClusters
unarchivedReturned to CRAN
2024-08-30
2.7.1
record
2024-08-30 · diff ↗ ·
removed 5 exports
.getOptionsH5, .h5ReadAntares, .writeAntaresH5Fun, isH5Opts, writeAntaresH5
archivedRemoved from CRAN
2024-06-28
repeated policy violation Spamming personal email address of CRAN team member in HTML Submitting with the same error at least 4x
2.7.0
record
2024-05-28 · diff ↗
R
R 4.4.0 released · 2024-04-24
2.6.1
record
2024-04-22 · diff ↗
2.6.0
record
2023-08-30 · diff ↗ ·
added 1 export
readClusterSTDesc

Show 36 earlier eventsHide 36 earlier events

R
R 4.3.0 released · 2023-04-21
2.5.1
record
2023-04-06 · diff ↗
2.5.0
record
2023-03-13 · diff ↗ ·
added 3 exports
mergeDigests, readDigestFile, writeDigest
2.4.2
record
2023-02-14 · diff ↗ ·
added 4 exports
getGeographicTrimming, readAntaresClusters, readInputRES, readInputThermal
2.3.1
record
2022-11-30 · diff ↗
2.3.0
record
2022-10-10 · diff ↗ ·
added 7 exports
api_delete, api_get, api_post, api_put, readIni, readIniAPI, readIniFile
R
R 4.2.0 released · 2022-04-22
2.2.95
record
2022-03-01 · diff ↗
2.2.9
record
2021-11-07 · diff ↗ ·
added 4 exports
getAlias, readClusterResDesc, setSimulationPathAPI, setTimeoutAPI
2.2.8
record
2021-06-22 · diff ↗
2.2.7
record
2021-06-08 · diff ↗
2.2.6
record
2021-05-28 · diff ↗ ·
added 5 exports
aggregateResult, hvdcModification, parAggregateMCall, ponderateMcAggregation, setHvdcAreas
R
R 4.1.0 released · 2021-05-18
R
R 4.0.0 released · 2020-04-24
2.2.5
record
2020-03-18 · diff ↗
2.2.4
record
2019-07-18 · diff ↗
R
R 3.6.0 released · 2019-04-26
2.2.3
record
2019-02-13 · diff ↗
2.2.2
record
2019-01-21 · diff ↗
2.2.1
record
2018-10-18 · diff ↗
2.2.0
record
2018-09-28 · diff ↗
2.1.2
record
2018-06-04 · diff ↗
2.1.1
record
2018-05-02 · diff ↗
R
R 3.5.0 released · 2018-04-23
unarchivedReturned to CRAN
2018-02-23
2.1.0
record
2018-02-23 · diff ↗
archivedRemoved from CRAN
2018-02-20
check problems were not corrected despite reminders Unconditional use of Suggests package(s) from BioC
2.0.2
record
2017-11-21 · diff ↗
2.0.1
record
2017-11-14 · diff ↗
2.0.0
record
2017-11-06 · diff ↗ ·
added 7 exports
.getOptionsH5, .h5ReadAntares, .writeAntaresH5Fun, isH5Opts, readOptimCriteria, setRam, writeAntaresH5
1.1.4
record
2017-07-11 · diff ↗
1.1.3
record
2017-05-30 · diff ↗
R
R 3.4.0 released · 2017-04-21
1.1.2
record
2017-04-20 · diff ↗
1.1.1
record
2017-04-03
R
R 3.3.0 released · 2016-05-03

Package metadata

First published: 2017-04-03
Total releases: 37 / 9 yrs
License: GPL (>= 2) | file LICENSE OSI
Download size: 3.0 MB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("antaresRead")

Format

Vargas, T., RTE, Berthet, C., Boitard, N., Breant, F., Guillem, F., Kemiha, K., Mahoudi, A., Mansouri, A., Perrier, V., Robert, T., Sanchez, E., Thieurmel, B., & ZAWAM, J. (2026). antaresRead: Import, Manipulate and Explore the Results of an 'Antares' Simulation (Version 3.1.0) [Computer software]. https://doi.org/10.32614/CRAN.package.antaresRead

This package has no citation file, so citation() returns this entry built from DESCRIPTION.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

Format

APA

Balamuta, J. J. (2026). R Observatory: Metrics for antaresRead version 3.1.0 [Data set]. HJJB, LLC. Data release v2026-10-24. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-24, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →