generateReportFb: Generate html report on a typical flow-based day

In rte-antares-rpackage/fbAntares:

Generate html report on a typical flow-based day

Description

This function generates an html report on one or several typical days, comparing the real and modelled domains. It hence can follow the use of the function computeFB. The report (one per day) is composed of several tabs: a summary of the volumetric errors (called inf and sup, representing real points forgotten in the model and modelled pointsmissing from the real domain) and plots for each hour of the real and modelled domains. The report can only be launched on data containing domains for each hour of the day

Usage

generateReportFb(
  dayType,
  output_file = NULL,
  countries = list(c("BE", "FR"), c("BE", "NL"), c("DE", "FR"), c("DE", "AT")),
  fb_opts = NULL,
  allFB = NULL,
  xlim = c(-12000, 12000),
  ylim = c(-12000, 12000)
)

Arguments

dayType	numeric, numerical id of the chosen typical flow-based days
output_file	character, output directory of the html reports. By default, the value is NULL, the reports will be written in the current directory.
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)
fb_opts	list of flowbased parameters (directory of the flow-based input) returned by the function setFlowbasedPath. By default, the value is indicated by fbAntares::fbOptions()
allFB	data.table, table of flow-based domains (real and modelled) returned by the function computeFB. By default, the value is NULL: in this case, the flow-based data is directly read in the model designated by the parameter fb_opts.
xlim	numeric, limits of x-axis
ylim	numeric, limits of y-axis

Examples

## Not run: 
#Generate report for the typical day 7 of a model (already designated by setFlowBasedPath)
generateReportFb(dayType = 7, fb_opts = fbAntares::fbOptions())

#Generate a report for the typical day 2 of a PTDF file
computeFB(PTDF = system.file("input/ptdf/ptdfraw.csv", package = "fbAntares"), dayType = 1)
domainesFB <- readRDS(system.file("input/model/antaresInput/domainesFB.rds", package = "fbAntares"))
generateReportFb(dayType = 1, allFB = domainesFB, 
  countries = list(c("BE", "FR"), c("BE", "NL"), c("DE", "FR"), c("DE", "AT")))

## End(Not run)

rte-antares-rpackage/fbAntares documentation built on June 1, 2022, 6:20 p.m.