as.antaresDataTable: 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 data.frame or a data.table into an antaresDataTable object.

An antaresDataTable is simply a data.table with additional attributes recording the time step, the type of data and the simulation options.

Usage

as.antaresDataTable(x, ...)

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

Arguments

x	object to convert to a an antaresDataList.
...	Arguments to be passed to methods.
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

antaresDataTable object.

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