readInputRES: Read Input RES time series

In rte-antares-rpackage/antaresRead: Import, Manipulate and Explore the Results of an 'Antares' Simulation

Read Input RES time series

Description

readInputRes is a function that reads renewable 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.

Usage

readInputRES(
  areas = "all",
  clusters,
  opts = simOptions(),
  timeStep = c("hourly", "daily", "weekly", "monthly", "annual"),
  simplify = TRUE,
  parallel = FALSE,
  showProgress = TRUE
)

Arguments

areas	vector of RES areas names for which renewable time series must be read.
clusters	vector of RES clusters names for which renewable time series must be read.
opts	list of simulation parameters returned by the function setSimulationPath
timeStep	Resolution of the data to import: hourly (default), daily, weekly, monthly or annual.
simplify	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".
parallel	Should the importation be parallelized ? (See details)
showProgress	If TRUE the function displays information about the progress of the importation.

Value

data.table with class "antaresDataTable".

See Also

setSimulationPath, readAntares, getAreas, getLinks

rte-antares-rpackage/antaresRead documentation built on Oct. 18, 2024, 7:49 a.m.