Skip to content
voiage

voiage.plot.ceaf.plot_ceaf

plot_ceaf

Section titled “plot_ceaf”
plot_ceaf([positional or keyword] value_array: ValueArray = None, [positional or keyword] wtp_thresholds: np.ndarray | list[float] = None, [positional or keyword] strategy_names: list[str] | None = None, [positional or keyword] result: CEAFResult | None = None, [positional or keyword] xlabel: str = 'Willingness-to-Pay Threshold', [positional or keyword] ylabel: str = 'Probability Optimal Strategy Is Cost-Effective', [positional or keyword] title: str = 'Cost-Effectiveness Acceptability Frontier (CEAF)', [positional or keyword] ax: Axes | None = None, [positional or keyword] show_uncertainty: bool = True, [variadic keyword] plot_kwargs: object = {}) -> Axes

Plot a cost-effectiveness acceptability frontier.

Parameters

Section titled “Parameters”

value_array : ValueArray 3D net-benefit surface used to build the frontier. wtp_thresholds : numpy.ndarray or list[float] Willingness-to-pay thresholds used for the x-axis. strategy_names : list[str], optional Override strategy names. result : CEAFResult, optional Precomputed CEAF result to plot. xlabel : str, default=“Willingness-to-Pay Threshold” X-axis label. ylabel : str, default=“Probability Optimal Strategy Is Cost-Effective” Y-axis label. title : str, default=“Cost-Effectiveness Acceptability Frontier (CEAF)” Plot title. ax : matplotlib.axes.Axes, optional Axes to draw on. show_uncertainty : bool, default=True Whether to draw the probability band. **plot_kwargs : object Keyword arguments forwarded to ax.plot.

Returns

Section titled “Returns”

matplotlib.axes.Axes Axes containing the CEAF plot.

Parameters:

  • value_array ValueArray
  • wtp_thresholds np.ndarray | list[float]
  • strategy_names list[str] | None (default: None)
  • result CEAFResult | None (default: None)
  • xlabel str (default: 'Willingness-to-Pay Threshold')
  • ylabel str (default: 'Probability Optimal Strategy Is Cost-Effective')
  • title str (default: 'Cost-Effectiveness Acceptability Frontier (CEAF)')
  • ax Axes | None (default: None)
  • show_uncertainty bool (default: True)
  • plot_kwargs object (default: {})

Returns: Axes