Skip to content
voiage

voiage.plot.voi_curves.plot_evsi_vs_sample_size

plot_evsi_vs_sample_size

Section titled “plot_evsi_vs_sample_size”
plot_evsi_vs_sample_size([positional or keyword] evsi_values: np.ndarray | list[float] = None, [positional or keyword] sample_sizes: np.ndarray | list[int] | list[float] = None, [positional or keyword] enbs_values: np.ndarray | list[float] | None = None, [positional or keyword] research_costs: np.ndarray | list[float] | None = None, [positional or keyword] xlabel: str = 'Sample Size (per arm or total)', [positional or keyword] ylabel_evsi: str = 'EVSI', [positional or keyword] ylabel_enbs: str = 'ENBS / Cost', [positional or keyword] title: str = 'Expected Value of Sample Information vs. Sample Size', [positional or keyword] ax: Axes | None = None, [positional or keyword] plot_evsi_kwargs: dict | None = None, [positional or keyword] plot_enbs_kwargs: dict | None = None, [positional or keyword] plot_cost_kwargs: dict | None = None) -> Axes

Plot EVSI against sample size with optional ENBS and cost curves.

Parameters

Section titled “Parameters”

evsi_values : numpy.ndarray or list[float] EVSI values. sample_sizes : numpy.ndarray or list[int] or list[float] Sample sizes corresponding to the EVSI values. enbs_values : numpy.ndarray or list[float], optional Optional ENBS values. research_costs : numpy.ndarray or list[float], optional Optional research costs. xlabel : str, default=“Sample Size (per arm or total)” X-axis label. ylabel_evsi : str, default=“EVSI” Y-axis label for EVSI. ylabel_enbs : str, default=“ENBS / Cost” Y-axis label for ENBS and cost curves. title : str, default=“Expected Value of Sample Information vs. Sample Size” Plot title. ax : matplotlib.axes.Axes, optional Axes to draw on. plot_evsi_kwargs : dict, optional Keyword arguments for the EVSI line. plot_enbs_kwargs : dict, optional Keyword arguments for the ENBS line. plot_cost_kwargs : dict, optional Keyword arguments for the research cost line.

Returns

Section titled “Returns”

matplotlib.axes.Axes Axes containing the EVSI plot.

Parameters:

  • evsi_values np.ndarray | list[float]
  • sample_sizes np.ndarray | list[int] | list[float]
  • enbs_values np.ndarray | list[float] | None (default: None)
  • research_costs np.ndarray | list[float] | None (default: None)
  • xlabel str (default: 'Sample Size (per arm or total)')
  • ylabel_evsi str (default: 'EVSI')
  • ylabel_enbs str (default: 'ENBS / Cost')
  • title str (default: 'Expected Value of Sample Information vs. Sample Size')
  • ax Axes | None (default: None)
  • plot_evsi_kwargs dict | None (default: None)
  • plot_enbs_kwargs dict | None (default: None)
  • plot_cost_kwargs dict | None (default: None)

Returns: Axes