geom_sii_riskoutline: geom_sii_riskoutline

In vanzanden/ggsolvencyii: A 'ggplot2'-Plot of Composition of Solvency II SCR: SF and IM

Description

returns a 'ggplot2' object, based on geom_path with the outlines concentric circle(part)s, defined by the values in a hierarchy of levels. This can be used instead of geom_sii_risksurface to plot the composition of the SCR. When optional aes(thetic) 'comparewithid' is passed to the geom_sii_riskoutline then the second SCR can be an overlay over another, for easy comparison.

Usage

geom_sii_riskoutline(data = NULL, mapping = NULL,
  stat = "sii_riskoutline",
  structure = ggsolvencyii::sii_structure_sf16_eng, squared = FALSE,
  levelmax = 99, aggregatesuffix = "_other", plotdetails = NULL,
  rotationdegrees = NULL, rotationdescription = NULL,
  maxscrvalue = NULL, scalingx = 1, scalingy = 1,
  position = "identity", na.rm = FALSE, show.legend = NA,
  inherit.aes = TRUE, ...)

Arguments

data	the dataset in tidyverse format (column 'description' as a factor). see examples in sii_z_ex2_data or sii_z_ex3_data
mapping	required aes(thetics) : 'x' (i.e. time, longitude, integer), 'y' (i.e SCR ratio, lattitude), 'id', 'description', 'value'. Optional aes is 'comparewithid'
stat	default stat is statsii_riskoutline, combinations with other stat's are not tested
structure	(dataframe: default = sii_structure_sf16_eng) A representation of the buildup from individual risks to the SCR. columns are description (chr), level (chr), childlevel (chr) . In the standard formula structure, SCR has level 1, with childlevel 2. This means it consists of all datalines with level == 2, ie. "BSCR", "operational" and "Adjustment-LACDT". lines in the dataset with a suffix "d" behind the levelnumber are diversification items. As of now these are not used in any calculation. the values in column "description" in the dataset need to match the description in this file. The package contains also a file sii_structure_sf16_nld with Dutch terms in description column.
squared	(optional, boolean, default = FALSE) when set to TRUE plot returns a square representation. Compared with a circle representation of the same data the height and width of the square are smaller than the radius of the circle. Segments which fall in the corner parts of the square are smaller than equally sized part which fall in the vertical or horizontal parts of the square.
levelmax	(integer or dataframe, default = 99) a positive integer or a dataframe with columns 'level' and 'levelmax'. The maximum amount of items in a certain level to be plotted. The smallest items are combined to one item. In the case level consisting of 7 items has a levelmax of 5 this results in 4 separate items and one grouped item. For a less detailed plot sii_levelmax_sf16_995 and sii_levelmax_sf16_993 are present in the package where the components of market, life, non-life, health are combined in 5 or 3 items.
aggregatesuffix	(string, default = "_other") When a certain level contains more items than specified by levelmax the smallest items are combined. The description is of the name of the one higher level (lower number) with a suffix
plotdetails	a table with columns 'levelordescription' and 'outline1' to 'outline4', indicating which outlines of which circle elements to plot. When no table is provided all segments are plotted. example 3 shows how to combine geom_sii_risksurface and geom_sii_riskoutline by using using table sii_z_ex3_plotdetails. geom_sii_risksurface uses another column in the same table.
rotationdegrees	(optional, integer, -360 to 360, default = NULL) when given, the fixed amount of degrees (positive is clockwise) of which each item is rotated (as in a compass, -90 is a quarter rotation anti-clockwise), additive to possible rotation to description
rotationdescription	(optional, string, default = NULL) default the orientation of the lower level (higher number) circles is based on the structure. When this parameter is not NULL then the circles are rotated in such a way that the indicated item lies in the "north-east" part of the circle.
maxscrvalue	(optional, double, default = NULL) the scale of the different plot elements is is by default measured to the largest level 1 element (i.e. SCR) in the dataset, this can be overridden by this parameter for example when combining several plots
scalingx	(optional, positive value ,default = 1) for plots where units in x and y are different in magnitude distortion can occur. This parameter scales only in x-direction
scalingy	(optional, positive value ,default = 1) for plots where units in x and y are different in magnitude distortion can occur. This parameter scales only in y-direction
position	standard ggplot function
na.rm	standard ggplot function
show.legend	standard ggplot function
inherit.aes	standard ggplot function
...	ellipsis, a standard R parameter

Details

When describing an outline of a circle part 4 segments can be distinguised, radial line outwards, outer circle segment, radial line inwards, inner circle segment. Whether or not to plot these lines can be determined with an outline dataframe. by means of the column aes()value comparewithid in the data an overlay can be made to compare two SCR representations.

Value

a 'ggplot2' object geom_sii_risksurface

Examples

library(ggsolvencyii)
library(ggplot2)

## see details about id and comparewithid
# sii_z_ex3_data[sii_z_ex3_data$description == "SCR", ]

ggplot()+
geom_sii_riskoutline(data = sii_z_ex3_data, mapping = aes(
  # comparewithid = comparewithid,
  x = time,
  y = ratio,
  value = value,
  id = id,
  description = description),
color = "red",
lwd = 0.7
)

##and with comparewithid in  aes()

ggplot()+
geom_sii_riskoutline(data = sii_z_ex3_data, mapping = aes(
  comparewithid = comparewithid,
  x = time,
  y = ratio,
  value = value,
  id = id,
  description = description),
color = "red",
lwd = 0.7
)

vanzanden/ggsolvencyii documentation built on May 31, 2019, 5:23 p.m.