generateClusteringReport: Generate html report

In rte-antares-rpackage/fbClust: A Tool Of Ptdf Manipulation In Order To Cluster And Visualize Domains

Generate html report

Description

Write and save a report with the results of the clustering of the flow-based domains. For one typical day, the report contains the representation of all the 24 hourly flow-based domains and their comparison with the domains of the other historical days it represents.

Usage

generateClusteringReport(dayType, outputFile, data,
  countries = list(c("BE", "FR"), c("BE", "NL"), c("DE", "FR"), c("DE",
  "AT")), xlim = c(-10000, 10000), ylim = c(-10000, 10000))

Arguments

dayType	numeric Typical day identifier
outputFile	character a folder where the html report is saved
data	data.table results from the clustering, output data from clusteringTypicalDays
countries	list, character a list of couples of countries to choose the axises for the projection of the flowbased domains (ex : list(c("BE", "FR"), c("BE", "NL"))) or an array of countries (ex : c("FR", "NL", "AT")) to project the domains on all the countries combination (here FR+NL, FR+AT and NL+AT)
xlim	numeric, limits of x-axis (default = c(-10000, 10000))
ylim	numeric, limits of x-axis (default = c(-10000, 10000))

Examples

## Not run: 

allTypDay <- readRDS(system.file("testdata/allTypDays.rds", package = "fbClust"))
generateClusteringReport(dayType = 1, data = allTypDay, outputFile = tempdir(),
countries = list(c("BE", "FR"), c("BE", "NL")), xlim = c(-12000, 12000),
ylim = c(-12000, 12000))

generateClusteringReport(dayType = 1, data = allTypDay, outputFile = tempdir(),
countries = c("AT", "FR", "NL", "DE"), xlim = c(-12000, 12000),
ylim = c(-12000, 12000))

## End(Not run)

rte-antares-rpackage/fbClust documentation built on July 4, 2023, 12:06 a.m.