Plot alignment scatterplot — plot_scatter • pacta.aggregate.loanbook.plots

Plot alignment scatterplot

Usage

plot_scatter(
  data,
  sector = NULL,
  scenario_source = NULL,
  scenario = NULL,
  year = NULL,
  region = NULL,
  title = NULL,
  subtitle = NULL,
  alignment_limit = NULL,
  data_level = c("company", "bank"),
  cap_outliers = NULL,
  floor_outliers = NULL
)

Arguments

data: data.frame. Should have the same format as output of prep_scatter() and contain columns: 'name', 'buildout', phaseout', 'net'.
sector: Character. Sector name to be used in the plot title.
scenario_source: Character. Scenario source to be used in the plot caption.
scenario: Character. Scenario name to be used in the plot caption.
year: Integer. Year of the analysis to be used in the plot caption.
region: Character. Region to be used in the plot caption.
title: Character. Custom title if different than default.
subtitle: Character. Custom subtitle if different than default.
alignment_limit: Numeric. Limit to be applied to the x- and y-axis scales and to alignment values for colouring. By default the maximum absolute alignment value of is used.
data_level: Character. Level of the plotted data. Can be 'bank' or 'company'.
cap_outliers: Numeric. Cap which should be applied to the alignment values in the data. Values bigger than cap are plotted on the border of the plot.
floor_outliers: Numeric. Floor which should be applied to the alignment values in the data. Values smaller than floor are plotted on the border of the plot.

Value

object of type "ggplot"

Examples

#TODO