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

## Documentation for package ‘antaresRead’ version 3.1.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

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