ptdfToVertices: Convert a PTDF file into a table of vertices

Description Usage Arguments Value Examples

View source: R/ptdfToVertices.R

Description

PTDF are the equations of the hyperplanes defining the limits of flow-based domains, while the vertices are the coordinnates of the extreme points of the domains.

Usage

1
ptdfToVertices(PTDF, nbCore = 1, maxDomainSize = 10000)

Arguments

PTDF

character, path of a PTDF file. The PTDF file must contains at least these seven columns : Date, Period, BE, DE, FR, NL and RAM - in this order. It must be a .csv file with ";" as column separator and "." as decimal separator. The names of the seven columns (Date, Period, ...) must be included in the header (first line) of the .csv file. The Period lies between 1 and 24 for the 24 hourly market periods. Therefore, period i corresponds to the time-step [i-1 ; i].

nbCore

numeric, number of cores for parallel computation. Default to one.

maxDomainSize

numeric limit of domain size in each axis. The function will return a warning if one domain or more exceed these limits.

Value

A data table with the vertices of the flow-based domains.

Examples

1
2
3
4
5
6
7
8
9
ptdf_data <- data.table::fread(system.file("dataset/ptdf_example.csv", 
   package = "flowBasedClustering"), data.table = F)

head(ptdf_data)

vertices <- ptdfToVertices(system.file("dataset/ptdf_example.csv",
    package = "flowBasedClustering"))

head(vertices)

rte-antares-rpackage/flowBasedClustering documentation built on Nov. 21, 2020, 11:21 a.m.