plotFB: Plot typical flow-based domains

In rte-antares-rpackage/fbAntares:

Plot typical flow-based domains

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 = fbAntares::fbOptions(),
  areaName = "cwe_at",
  xlim = c(-12000, 12000),
  ylim = c(-12000, 12000),
  export = T
)

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 fbAntares::fbOptions()
areaName	character The name of the area of your study, possible values are cwe_at (default), cwe and other. If you choose other, you have to give a csv file which explains how your area work.
xlim	numeric, limits of x-axis
ylim	numeric, limits of y-axis
export	logical If you want the possibility to export your graphic (if true in rmarkdown, can return a blank html)

Examples

## Not run: 
 fb_opts <- setFlowbasedPath(path = system.file("input/model/antaresInput/", 
 package = "fbAntares"))
 plotFB(dayType = 1, hour = 1, country1 = "FR", country2 = "NL", 
 fb_opts = fb_opts, areaName = "cwe_at")
 plotFB(dayType = 1, hour = 1:4,country1 = "FR",country2 = "NL", 
 fb_opts = fb_opts, areaName = "cwe")
 plotFB(dayType = 1, hour = 1:2, country1 = "DE", country2 = "AT", 
 fb_opts = fb_opts, areaName = "cwe_at")
 plotFB(dayType = 1, hour = 1, country1 = c("FR", "DE"), 
     country2 = c("NL", "FR"), fb_opts = fb_opts, areaName = "cwe_at")

## End(Not run)

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