as.antaresDataList: Convert objects to antaresDataTable

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

Convert objects to antaresDataTable

Description

This function converts a list of tables or table into an antaresDataList object.

An antaresDataList is a list of tables of classantaresDataTable. It also has attributes that store the time step, the type of data and the simulation options.

Usage

as.antaresDataList(x, ...)

## S3 method for class 'antaresDataTable'
as.antaresDataList(x, name = NULL, ...)

## S3 method for class 'data.frame'
as.antaresDataList(
  x,
  synthesis,
  timeStep,
  type,
  opts = simOptions(),
  name = type,
  ...
)

Arguments

x	Data.frame or data.table to convert to a an antaresDataTable.
...	Arguments to be passed to methods.
name	name of the table in the final object. If NULL, the type of the data is used.
synthesis	Does the table contain synthetic results ?
timeStep	Time step of the data. One of "hourly", "daily", "weekly", "monthly" or "annual".
type	type of data: for instance "areas", "links", "clusters", etc.
opts	Simulation options.

Value

antaresDataList object.

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