Skip to content
voiage

voiage.cli.calculate_nma_voi

calculate_nma_voi

Section titled “calculate_nma_voi”
calculate_nma_voi([positional or keyword] config_file: Path = typer.Argument(..., metavar='CONFIG_FILE', exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to JSON config file defining NMA data'), [positional or keyword] parameters_of_interest: str | None = typer.Option(None, '--parameters-of-interest', '-p', help="Comma-separated list of parameters for EVPPI (e.g., 'effect_A,effect_B')"), [positional or keyword] willingness_to_pay: float | None = typer.Option(None, '--willingness-to-pay', '-w', help='Willingness-to-pay threshold per unit'), [positional or keyword] population: float | None = typer.Option(None, '--population', help='Population size for population-adjusted VOI'), [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 NMA VOI result')) -> None

Calculate VOI for Network Meta-Analysis (NMA-EVPI or NMA-EVPPI).

The config file should be a JSON file with the following format:

\b { “treatment_effects”: { “Placebo-Drug_A”: [0.5, 0.6, 0.4, …], “Placebo-Drug_B”: [0.7, 0.8, 0.6, …], “Drug_A-Drug_B”: [0.2, 0.1, 0.3, …] }, “n_studies”: 10, “treatments”: [“Placebo”, “Drug_A”, “Drug_B”], “outcome_type”: “continuous” }

If –parameters-of-interest is provided, calculates EVPPI; otherwise EVPI.

Examples

Section titled “Examples”

Calculate NMA EVPI from a JSON config:

.. code-block:: bash

voiage calculate-nma-voi nma_config.json

Parameters:

  • config_file Path (default: typer.Argument(..., metavar='CONFIG_FILE', exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to JSON config file defining NMA data'))
  • parameters_of_interest str | None (default: typer.Option(None, '--parameters-of-interest', '-p', help="Comma-separated list of parameters for EVPPI (e.g., 'effect_A,effect_B')"))
  • willingness_to_pay float | None (default: typer.Option(None, '--willingness-to-pay', '-w', help='Willingness-to-pay threshold per unit'))
  • population float | None (default: typer.Option(None, '--population', help='Population size for population-adjusted VOI'))
  • 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 NMA VOI result'))

Returns: None