adqPatch: Run the adequacy patch

Description Usage Arguments Examples

View source: R/adqPatch.R

Description

This function runs the adequacy patch on an ANTARES study output. It is a post-processing on the results which can affect the variables BALANCE, LOLD, UNSP. ENRG, DTG MRG of the areas be, de, fr and nl and the variable FLOW LIN. of the links between these areas. For more detailed explanation, please report to the example to open the vignette.

Usage

1
2
3
adqPatch(mcYears = "all", pre_filter = FALSE, strategic_reserve_be = NULL,
  strategic_reserve_de = NULL, opts = antaresRead::simOptions(),
  fb_opts = opts, select = NULL, keepOldColumns = TRUE)

Arguments

mcYears

numeric vector of mcYears to process. By default, the value is all (all mcYears are loaded).

pre_filter

boolean: if TRUE, the function selects (by reading annual results) the mcYears during which there is at least one hour of loss of load before applying the adequacy patch, the other years are not loaded and will not appear in the results of the function. By default, the value is FALSE.

strategic_reserve_be

character name of the virtual area representing the strategic reserve of Belgium. Default to NULL.

strategic_reserve_de

character name of the virtual area representing the strategic reserve of Germany. Default to NULL.

opts

list of simulation parameters returned by the function setSimulationPath. Defaut to antaresRead::simOptions()

fb_opts

list of simulation parameters returned by the function setSimulationPath or flow-based model path obtained with the function setFlowbasedPath. Defaut to antaresRead::simOptions()

select

character, names of output columns (variables) to be displayed after the adequacy patch post-process. The columns modified by the adequacy patch are automatically displayed (BALANCE, LOLD, UNSP. ENRG, DTG MRG and FLOW LIN.)

keepOldColumns

boolean: if TRUE, the initial columns modified by the adequacy patch are also displayed after the post-processing. By default, the value is TRUE.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
## Not run: 
#Presentation of the adequacy patch
browseVignettes()


antaresRead::setSimulationPath("D:/Users/titorobe/Desktop/antaresStudy", 2)

#No strategic reserve
res <- adqPatch()

#Strategic reserve
res <- adqPatch(strategic_reserve_de = "lu_de", strategic_reserve_be = "lu_be")

#Add a new column
res <- adqPatch(strategic_reserve_de = "lu_de", strategic_reserve_be = "lu_be", select = "COAL")

#Remove old columns
res <- adqPatch(keepOldColumns = FALSE)

## End(Not run)

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