readEnergy: Read energy data for an area

Description Usage Arguments Value Examples

View source: R/readEnergy.R

Description

Read energy data for an area

Usage

1
readEnergy(area, timeStep = "daily", opts = antaresRead::simOptions())

Arguments

area

An 'antares' area.

timeStep

Resolution of the data to import: daily (default, values are divided by number of days), weekly, monthly (original data).

opts

List of simulation parameters returned by the function antaresRead::setSimulationPath

Value

a data.table

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
## Not run: 
library(antaresWeeklyMargin)
library(antaresRead)

# set path to your simulation
opts <- setSimulationPath(path = "test_case/", simulation = "input")

weekly <- readEnergy(area = "fr", timeStep = "weekly", opts = opts)
weekly

daily <- readEnergy(area = "fr", timeStep = "daily", opts = opts)
daily

monthly <- readEnergy(area = "fr", timeStep = "monthly", opts = opts)
monthly

## End(Not run)

rte-antares-rpackage/antaresWeeklyMargin documentation built on July 25, 2019, 8:23 p.m.