fig_path_bid_prices¶

passengersim.tracers.bid_price.fig_path_bid_prices(summary: SimulationTables, *, std_dev: bool = True, include: tuple[str] | None = None, raw_df: bool = False, ids: tuple[int] | None = None) → alt.Chart | pd.DataFrame[source]¶

Plot mean (and optionally standard-deviation) bid prices for tracked paths.

Parameters:

summary : SimulationTables or Contrast¶

Simulation results to plot. A Contrast mapping is also accepted.

std_dev : bool, optional¶

When True (default), a second panel showing the standard deviation is placed beside the mean panel.

include : tuple[str] | None, optional¶

When summary is a Contrast, restrict the plot to only the keys listed here.

raw_df : bool, optional¶

When True, return the tidy pandas.DataFrame instead of an Altair chart. Defaults to False.

ids : tuple[int] | None, optional¶

Restrict the plot to the path IDs listed here. When None (default) all tracked paths are shown.

Returns:

alt.Chart or pd.DataFrame – An Altair chart when raw_df is False, or a pandas.DataFrame when raw_df is True.