showRegiLinePlots: Show Line Plots for Region Comparison

View source: R/showRegiLinePlots.R

showRegiLinePlotsR Documentation

Show Line Plots for Region Comparison

Description

Shows line plots of a variable with different regions in the same plot and faceting by scenario.

Usage

showRegiLinePlots(
  data,
  vars,
  scales = "free_y",
  excludeMainRegion = TRUE,
  mainReg = getOption("mip.mainReg")
)

Arguments

data

A quitte object or an object that can be transformed into a quitte object.

vars

A character vector. The variables to be plotted.

scales

A single string. choose either "free_y" or "fixed".

excludeMainRegion

A single logical value. Should the main region be excluded (or shown in the same plot)?

mainReg

A single string. Use options(mip.mainReg=<value>) to set globally.

Details

Creates one set of plots with the values of vars over time. Does not show historical data. Different regions are shown in the same plot. Faceting is done by scenario. The plots arranged and shown.

Value

NULL is returned invisible.

Example Plots

showRegiLinePlots.png

Examples

## Not run: 
options(mip.mainReg = "World")
data <- as.quitte(data)
showRegiLinePlots(data, "Price|Carbon")

## End(Not run)

pik-piam/mip documentation built on April 5, 2024, 12:31 p.m.