identifyFirstDay: Identify the type of the first day of a study

Description Usage Arguments Examples

View source: R/firstDay.R

Description

This function identifies the nature of the first day of a study, by reading the input load data of the study designated by opts (calculation of the mean profile of each day to identify the weekend). The type of first day is represented by a number : 1 = Monday, 2 = Tuesday, ..., 7 = Sunday.

Usage

1
2
identifyFirstDay(opts, firstArea = "fr", secondArea = c("fr", "de", "be",
  "nl"))

Arguments

opts

list of simulation parameters returned by the function setSimulationPath : path of the Antares study. By default, the value is indicated by antaresRead::simOptions().

firstArea

character name of the area(s) to use to calculate the type of first day. By default, France ("fr") is chosen.

secondArea

character name of additional area(s) to use to check the first day. By default, the value is c("fr", "de", "be", "nl") (France, Germany, Belgium, the Netherlands). It can be NULL but the first day will be determined with less certainty.

Examples

1
2
3
4
5
6
## Not run: 
# Identification of the first day of an Antares study where areas fr, be, de, nl exist
opts <- setSimulationPath("pathToAntaresStudy")
identifyFirstDay(opts)

## End(Not run)

rte-antares-rpackage/antaresFlowbased documentation built on Oct. 19, 2020, 11:23 a.m.