clusterPlot: Plot a flow-based domain of a typical day

In rte-antares-rpackage/flowBasedClustering: Cluster 'Flow-Based' Typical Days

Description

For a given hour, plot the flow-based domain of one typical day along with the other flow-based domains it represents (i.e. other domains of the same cluster).

Usage

clusterPlot(data, country1, country2, hour, dayType, typicalDayOnly = FALSE,
  ggplot = FALSE, width = "420px", height = "410px")

Arguments

data	data.table results from the clustering, output data from clusteringTypicalDays or clusterTypicalDaysForOneClass
country1	character, name of the country whose net position is in the x axis (BE, FR, DE or NL)
country2	character, name of the country whose net position is in the y axis (BE, FR, DE or NL)
hour	numeric, hour of the plotted domain
dayType	numeric, typical flow-based day identifier
typicalDayOnly	logical if TRUE, plot only the domain of the typical day and not the other domains of the cluster
ggplot	logical should ggplot package be used (static graph) instead of rAmCharts (dynamic graph)
width	character, for rAmCharts only. Default to "420px" (set to "100/100" for dynamic resize)
height	character, for rAmCharts only. Default to "410px" (set to "100/100" for dynamic resize)

Examples

# classification result
clusterTD <- readRDS(system.file("dataset/cluster_example.RDS",package = "flowBasedClustering"))

clusterPlot(clusterTD, "FR", "DE", 8, 9, FALSE, FALSE)
clusterPlot(clusterTD, "FR", "DE", 8, 9, FALSE, TRUE)
clusterPlot(clusterTD, "FR", "DE", 8, 9, TRUE, TRUE)
clusterPlot(clusterTD, "FR", "DE", 8, 9, TRUE, FALSE)

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