Skip to content
voiage

voiage.cli.calculate_sequential_voi

calculate_sequential_voi

Section titled “calculate_sequential_voi”
calculate_sequential_voi([positional or keyword] parameter_file: Path = typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to CSV containing PSA parameters (samples x parameters)'), [positional or keyword] dynamic_spec_file: Path = typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to JSON dynamic specification with time_steps'), [positional or keyword] wtp: float = typer.Option(0.0, '--wtp', help='Willingness-to-pay threshold'), [positional or keyword] population: float | None = typer.Option(None, '--population', help='Population size for scaling'), [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] optimization_method: str = typer.Option('backward_induction', '--optimization-method', help='Sequential optimization method'), [positional or keyword] output_file: Path | None = typer.Option(None, '--output', '-o', help='File to save sequential VOI result')) -> None

Calculate sequential VOI using a dynamic specification.

Examples

Section titled “Examples”

Calculate sequential VOI from a parameter CSV and dynamic spec JSON:

.. code-block:: bash

voiage calculate-sequential-voi parameters.csv dynamic_spec.json

Parameters:

  • parameter_file Path (default: typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to CSV containing PSA parameters (samples x parameters)'))
  • dynamic_spec_file Path (default: typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to JSON dynamic specification with time_steps'))
  • wtp float (default: typer.Option(0.0, '--wtp', help='Willingness-to-pay threshold'))
  • population float | None (default: typer.Option(None, '--population', help='Population size for scaling'))
  • 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'))
  • optimization_method str (default: typer.Option('backward_induction', '--optimization-method', help='Sequential optimization method'))
  • output_file Path | None (default: typer.Option(None, '--output', '-o', help='File to save sequential VOI result'))

Returns: None