plot_compare_mainmode_sankey: Plot alluvial/sankey diagram of transport mode changes

In matsim-vsp/matsim-r: R library for interfacing with MATSim agent-based microsimulation model

Plot alluvial/sankey diagram of transport mode changes

Description

Takes two tibbles from read_output_trips and compares the mode choice for each agent and summarizes the results, showing the modal shift. Using the parameter unite_modes, specific modes can be renamed into one with the name specified with united_name (by default 'united') The parameter show.onlyChanges allows the visualization of only the mode shift (excluding the trips that do not change mode). Standard value is FALSE.

Usage

plot_compare_mainmode_sankey(
  trips_table1,
  trips_table2,
  show_onlychanges = FALSE,
  unite_modes = character(0),
  united_name = "united"
)

Arguments

trips_table1	tibble of trips_output (from read_output_trips())
trips_table2	tibble of trips_output (from read_output_trips())
show_onlychanges	boolean, if it is set to TRUE the sankey diagram only shows the mode shift
unite_modes	optional, vector of character strings, changes names of chosen modes in the column main_mode to a new chosen name (i.e. drtNorth and drtSouth to drt), using the function (process_rename_mainmodes)
united_name	optional, character string, specifies the name of the united mode

Value

Alluvial diagram that represents changes in transport mode distribution

matsim-vsp/matsim-r documentation built on Feb. 3, 2025, 6:48 p.m.