Man pages for antaresRead
Import, Manipulate and Explore the Results of an 'Antares' Simulation

aggregatate_mc_allCreation of Mc_all new (only antares > V6)
antaresRead-packageantaresRead: Import, Manipulate and Explore the Results of an...
API-methodsAPI methods
as.antaresDataListConvert objects to antaresDataTable
as.antaresDataTableConvert objects to antaresDataTable
changeTimeStepChange the timestep of an output
copyToClipboardCopy data to the clipboard
dot-download_api_aggregate_resultRetrieve information on a file's state of preparation and...
dot-filter_bindingConstraints_by_namesFilter a list of binding constraints by names by a exact...
dot-transform_antares_versionConvert the Antares number version
dot-writeIniWrite ini file from list obtain by antaresRead::readIniFile...
extractDataListFormat data PPSE-style
getAreasSelect and exclude areas
getGeographicTrimmingRead geographic trimming (filtering) options
getIdColsget Id columns
getLinksRetrieve links connected to a set of areas
getThematicTrimmingGet the Thematic trimming of an Antares study
hvdcModificationhvdc straitement
list_thematic_variablesList of thematic trimming variables available according to...
mergeDigestsMerge two digests
ponderateMcAggregationMcyear aggregation weigthed by wd
readAntaresRead the data of an Antares simulation
readAntaresAreasRead output for a list of areas
readAntaresClustersRead output for a list of clusters
readAntaresSTClustersRead output for a list of short-term storage clusters
readBindingConstraintsRead binding constraints
readClusterDescImport clusters description
readDigestFileRead digest file
read-iniRead configuration options from file or API
readInputRESRead Input RES time series
readInputThermalRead Input thermal time series
readInputTSRead Input time series
readLayoutRead areas layout
readOptimCriteriaRead Optimization Criteria
read_storages_constraintsRead Short-term storages / additional constraints
removeVirtualAreasRemove virtual areas
setAliasshow aliases for variables
setHvdcAreasSet hvdc areas
setRamSpecify RAM limit
setSimulationPathSet Path to an Antares simulation
setTimeoutAPIChange API Timeout
simOptionsExtract simulation options
subset.antaresDataListSubset an antaresDataList
summary.bindingConstraintsDisplay equation of binding constraint
viewAntaresView the content of an antares output
writeDigestWrite digest file
antaresRead documentation built on Nov. 5, 2025, 7:42 p.m.