pcn_stop_clusters: Get sum of PCN for stopped clusters by weeks

In rte-antares-rpackage/antaresThermalTS: Extended Shutdown Simulation with 'Antares' for Power Groups

Description

Get sum of PCN for stopped clusters by weeks

Usage

pcn_stop_clusters(
  first_weekday = 1,
  area = "fr",
  remove_clusters = NULL,
  start_date = NULL,
  opts = simOptions()
)

Arguments

first_weekday	The first day to use for starting a week, default to 1 (monday).
area	Area(s) to include in the computation.
remove_clusters	Character vector. Cluster(s) to remove.
start_date	Starting date of the study. If NULL (the default), the date of the antares study is used.
opts	List of simulation parameters returned by the function setSimulationPath

Value

a data.table.

Examples

## Not run: 

library(antaresRead)
setSimulationPath(path = "PATH/TO/STUDY")

pcn_stop_clusters()

pcn_stop_clusters(first_weekday = 6) # saturday


## End(Not run)

rte-antares-rpackage/antaresThermalTS documentation built on May 14, 2020, 1:48 a.m.