Skip to content
voiage

voiage.plot.dominance.plot_cost_effectiveness_plane

plot_cost_effectiveness_plane

Section titled “plot_cost_effectiveness_plane”
plot_cost_effectiveness_plane([positional or keyword] costs: np.ndarray | list[float] = None, [positional or keyword] effects: np.ndarray | list[float] = None, [positional or keyword] strategy_names: list[str] | None = None, [positional or keyword] result: DominanceResult | None = None, [positional or keyword] xlabel: str = 'Effect', [positional or keyword] ylabel: str = 'Cost', [positional or keyword] title: str = 'Cost-Effectiveness Plane', [positional or keyword] ax: Axes | None = None, [variadic keyword] scatter_kwargs: Any = {}) -> Axes

Plot strategies and the cost-effectiveness frontier.

Parameters

Section titled “Parameters”

costs : numpy.ndarray or list[float] Strategy costs. effects : numpy.ndarray or list[float] Strategy effects. strategy_names : list[str], optional Optional strategy labels. result : DominanceResult, optional Precomputed dominance result to plot. xlabel : str, default=“Effect” X-axis label. ylabel : str, default=“Cost” Y-axis label. title : str, default=“Cost-Effectiveness Plane” Plot title. ax : matplotlib.axes.Axes, optional Axes to draw on. **scatter_kwargs : Any Keyword arguments forwarded to ax.scatter.

Returns

Section titled “Returns”

matplotlib.axes.Axes Axes containing the cost-effectiveness plane plot.

Parameters:

  • costs np.ndarray | list[float]
  • effects np.ndarray | list[float]
  • strategy_names list[str] | None (default: None)
  • result DominanceResult | None (default: None)
  • xlabel str (default: 'Effect')
  • ylabel str (default: 'Cost')
  • title str (default: 'Cost-Effectiveness Plane')
  • ax Axes | None (default: None)
  • scatter_kwargs Any (default: {})

Returns: Axes