voiage.plot.ceac.plot_ceac
plot_ceac
Section titled “plot_ceac”plot_ceac([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] xlabel: str = 'Willingness-to-Pay Threshold', [positional or keyword] ylabel: str = 'Probability Cost-Effective', [positional or keyword] title: str = 'Cost-Effectiveness Acceptability Curve (CEAC)', [positional or keyword] ax: Axes | None = None, [variadic keyword] plot_kwargs_per_strategy: object = {}) -> AxesPlot a cost-effectiveness acceptability curve.
Parameters
Section titled “Parameters”value_array : ValueArray 3D net-benefit surface with samples, strategies, and WTP thresholds. wtp_thresholds : numpy.ndarray or list[float] Willingness-to-pay thresholds used for the x-axis. strategy_names : list[str], optional Override strategy names. xlabel : str, default=“Willingness-to-Pay Threshold” X-axis label. ylabel : str, default=“Probability Cost-Effective” Y-axis label. title : str, default=“Cost-Effectiveness Acceptability Curve (CEAC)” Plot title. ax : matplotlib.axes.Axes, optional Axes to draw on. **plot_kwargs_per_strategy : object Optional list of per-strategy keyword argument dictionaries.
Returns
Section titled “Returns”matplotlib.axes.Axes Axes containing the CEAC plot.
A CEAC shows the probability that each strategy is optimal across the supplied willingness-to-pay thresholds.
Parameters:
value_arrayValueArraywtp_thresholdsnp.ndarray | list[float]strategy_nameslist[str] | None(default:None)xlabelstr(default:'Willingness-to-Pay Threshold')ylabelstr(default:'Probability Cost-Effective')titlestr(default:'Cost-Effectiveness Acceptability Curve (CEAC)')axAxes | None(default:None)plot_kwargs_per_strategyobject(default:{})
Returns: Axes