Skip to content
voiage

voiage.cli.calculate_structural_evppi

calculate_structural_evppi

Section titled “calculate_structural_evppi”
calculate_structural_evppi([positional or keyword] config_file: Path = typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to JSON config file defining model structures'), [positional or keyword] structures_of_interest: list[int] | None = typer.Option(None, '--structures-of-interest', '-s', help='Indices of structures to learn about (0-indexed, can specify multiple)'), [positional or keyword] parameters_of_interest: list[int] | None = typer.Option(None, '--parameters-of-interest', '-p', help='Alias for --structures-of-interest for structural EVPPI'), [positional or keyword] population: float | None = typer.Option(None, '--population', help='Population size for population-adjusted structural EVPPI'), [positional or keyword] discount_rate: float | None = typer.Option(None, '--discount-rate', help='Annual discount rate (e.g., 0.03)'), [positional or keyword] time_horizon: float | None = typer.Option(None, '--time-horizon', help='Time horizon in years'), [positional or keyword] output_file: Path | None = typer.Option(None, '--output', '-o', help='File to save structural EVPPI result')) -> None

Calculate Structural Expected Value of Partial Perfect Information (SEVPPI).

Structural EVPPI quantifies the expected gain from resolving uncertainty about a specific subset of model structures.

The config file format is the same as for structural EVPI.

Examples

Section titled “Examples”

Calculate structural EVPPI for selected structures:

.. code-block:: bash

voiage calculate-structural-evppi structural_config.json –structures-of-interest 0 2

Parameters:

  • config_file Path (default: typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to JSON config file defining model structures'))
  • structures_of_interest list[int] | None (default: typer.Option(None, '--structures-of-interest', '-s', help='Indices of structures to learn about (0-indexed, can specify multiple)'))
  • parameters_of_interest list[int] | None (default: typer.Option(None, '--parameters-of-interest', '-p', help='Alias for --structures-of-interest for structural EVPPI'))
  • population float | None (default: typer.Option(None, '--population', help='Population size for population-adjusted structural EVPPI'))
  • discount_rate float | None (default: typer.Option(None, '--discount-rate', help='Annual discount rate (e.g., 0.03)'))
  • time_horizon float | None (default: typer.Option(None, '--time-horizon', help='Time horizon in years'))
  • output_file Path | None (default: typer.Option(None, '--output', '-o', help='File to save structural EVPPI result'))

Returns: None