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


[Up] [Top]

Documentation for package ‘antaresRead’ version 2.6.1

Help Pages

.writeIni Write ini file from list obtain by antaresRead:::readIniFile and modify by user
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
hvdcModification hvdc straitement
isH5Opts Test if opts is h5
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
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
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 Read binding constraints
viewAntares View the content of an antares output
writeAntaresH5 Convert antares output to h5 file
writeDigest Write digest file