plotFB: Plot typical flow-based domains

In rte-antares-rpackage/antaresFlowbased: Run FlowBased Simulations on Antares

Description

This function enables to plot one or several typical flow-based domains, in 2 dimensions (the axis being 2 countries).

Usage

plotFB(dayType, hour, country1, country2,
  fb_opts = antaresFlowbased::fbOptions())

Arguments

dayType	numeric, numerical id of the typical day(s)
hour	numeric, hour(s) (can be from 0 to 23 or from 1 to 24 depending on the data of the flow-based model)
country1	character, name of the country (axis X)
country2	character, name of the country (axis Y)
fb_opts	list of flowbased parameters returned by the function setFlowbasedPath : directory of the flow-based model. By default, the value is indicated by antaresFlowbased::fbOptions()

Examples

## Not run: 
 fb_opts = antaresFlowbased::fbOptions()
 plotFB(dayType = 1, hour = 1, country1 = "FR", country2 = "NL", fb_opts = fb_opts)
 plotFB(dayType = 1:2, hour = 1,country1 = "FR",country2 = "NL", fb_opts = fb_opts)
 plotFB(dayType = 1:2, hour = 1:2, country1 = "FR", country2 = "NL", fb_opts = fb_opts)
 plotFB(dayType = 1, hour = 1, country1 = c("FR", "DE"), 
     country2 = c("NL", "FR"), fb_opts = fb_opts)

## End(Not run)

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