readInputThermal is a function that reads thermal time series from an antares
project. But contrary to readAntares, it only reads time series
stored in the input folder, so it can work in "input" mode.
readInputThermal(
areas = "all",
clusters,
thermalAvailabilities = TRUE,
thermalModulation = FALSE,
thermalData = FALSE,
opts = simOptions(),
timeStep = c("hourly", "daily", "weekly", "monthly", "annual"),
simplify = TRUE,
parallel = FALSE,
showProgress = TRUE
)vector of areas names for which thermal time series must be read.
vector of clusters names for which thermal time series must be read.
if TRUE, return thermalAvailabilities data
if TRUE, return thermalModulation data
if TRUE, return thermalData from prepro
list of simulation parameters returned by the function
setSimulationPath
Resolution of the data to import: hourly (default), daily, weekly, monthly or annual.
If TRUE and only one type of output is imported then a data.table is returned. If FALSE, the result will always be a list of class "antaresData".
Should the importation be parallelized ? (See details)
If TRUE the function displays information about the progress of the importation.
If thermalModulation or thermalData is TRUE, an object of class "antaresDataList" is returned. It is a list of data.tables for selected input
Else the result is a data.table with class "antaresDataTable".
the clusters parameter can also accept the special value "all". It indicates the function to read the desired time series for all clusters.