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

Description Usage Arguments Examples

View source: R/graph.R

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 points missing from the real domain) and plots for each hour of the real and modelled domains.

Usage

1
2
generateReportFb(dayType, output_file = NULL,
  fb_opts = antaresFlowbased::fbOptions(), allFB = NULL)

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.

fb_opts

list of flowbased parameters (directory of the flow-based input) returned by the function setFlowbasedPath. By default, the value is indicated by antaresFlowbased::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.

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
#Generate report for the typical day 7 of a model (already designated by setFlowBasedPath)
generateReportFb(dayType = 7, fb_opts = antaresFlowbased::fbOptions())

#Generate a report for the typical day 7 of a PTDF file
allFB <- computeFB(PTDF = "/path/PTDF_file.csv",reports = FALSE, dayType = 7)
generateReportFb(dayType = 7, fb_opts = antaresFlowbased::fbOptions(), allFB = allFB)

## End(Not run)

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