computeFB: Conversion of flow-based domains into an ANtares model with...

Description Usage Arguments Examples

View source: R/computeFB.R

Description

This function follows two steps: based on the list of flow-based domains given in input, it will calculate a standard shape (selection of sides, k-medoid method) and will then project the real domains on this standard shape. The projection is computed using an optimisation algorithm aiming at minimising the volumetric error between the real domain and its projection. The function will then write in an output directory the standard shape (weights.txt), the projection result for each domain (second_member.txt) and an RDS object storing information on the projection and the errors. Reports can be written represening the real and modelled domains and the volumetric error between them.

Usage

1
2
3
4
computeFB(PTDF = system.file("/input/ptdf/PTDF.csv", package =
  "antaresFlowbased"), outputName = paste0(getwd(), "/antaresInput"),
  reports = TRUE, dayType = "All", hour = "All", nbFaces = 36,
  verbose = 0)

Arguments

PTDF

character, path leading to the flow-based domains (PTDF description) list. By default, this leads to an example file ("PTDF.csv", saved in the package). This must be a csv file containing the following columns (and column names):

  • Id_day : numeric, name of each day. Default in example id_day between 1 and 12.

  • Period : numeric, hour of the day. Default in example period between 1 and 24 (1 is then between 00:00 and 01:00).

  • BE : numeric, PTDF coefficient of Belgium.

  • DE : numeric, PTDF coefficient of Germany.

  • FR : numeric, PTDF coefficient of France.

  • NL : numeric, PTDF coefficient of the Netherlands.

  • RAM : numeric, remaining available capacity in the critical branch (MW).

outputName

character, path/name of the output directory. By default, the value is a created directory named "antaresInput" in the current directory

reports

boolean, if TRUE, the function will write html reports (one per typical day). By default, the value is TRUE.

dayType

numeric, by default, the value is All. (optional) Vector of id_days to compute.

hour

numeric, by default, the value is All. (optional) vector of hours/periods to compute.

nbFaces

numeric, standard shape parameters: number of sides to select. By default, the value is 36.

verbose

numeric, shows the logs in console. By default, the value is 0.

  • 0 : No log

  • 1 : Short log

Examples

1
2
3
4
5
6
7
8
## Not run: 
# Compute models for all days and hours of a PTDF file, with no reports 
# automatically generated at the same time

computeFB(PTDF = system.file("/input/ptdf/PTDF.csv", package = "antaresFlowbased"), reports = FALSE)


## End(Not run)

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