drawVolumeHeatmapTwoDimensions: Draw a volume heatmap comparing the volumes of two...

View source: R/heatmaps.R

drawVolumeHeatmapTwoDimensionsR Documentation

Draw a volume heatmap comparing the volumes of two polyhedrons making combinations of possible net positions for the studied countries

Description

This function returns a heatmap comparing the volumes of two polyhedrons in different directions corresponding to all the combinations of the positive/negative net positions of each country

Usage

drawVolumeHeatmapTwoDimensions(
  A,
  B = NULL,
  nbPoints = 50000,
  seed = 123456,
  assessment_range = c(-15000, 15000)
)

Arguments

A

data.table, polyhedron, data.table containing at least two ptdf columns :

  • ptdfAT : autrichian vertices

  • ptdfBE : belgium vertices

  • ptdfDE : german vertices

  • ptdfFR : french vertices

B

data.table, polyhedron, data.table containing at least two ptdf columns :

  • ptdfAT : autrichian vertices

  • ptdfBE : belgium vertices

  • ptdfDE : german vertices

  • ptdfFR : french vertices

If B is NULL, the heatmap returns the absolute volume of A in the different directions.

nbPoints

numeric, number of points generated for volume comparison

seed

numeric fixed random seed, used for the weighted draw of the points for volume assessment. By default, the value is 123456

assessment_range

The range in which the points for the volume assessment should be drawn

Examples

## Not run: 
library(data.table)
polyhedra <- readRDS(system.file("testdata/polyhedra.rds", package = "fbAntares"))
A <- polyhedra[Date == "2019-02-14"]
B <- polyhedra[Date == "2019-02-15"]
nbPoints <- 50000

 drawVolumeHeatmapTwoDimensions(A = A, B = B, nbPoints = nbPoints)

## End(Not run)


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