Skip to content
voiage

voiage.cli.calculate_observational

calculate_observational

Section titled “calculate_observational”
calculate_observational([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] observational_study_design_file: Path = typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to JSON observational study design'), [positional or keyword] bias_models_file: Path = typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to JSON bias-model specification'), [positional or keyword] model: str | None = typer.Option(None, '--model', '-m', help='Dotted path to a callable accepting ParameterSet and returning ValueArray'), [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] n_outer_loops: int = typer.Option(20, '--n-outer-loops', help='Outer Monte Carlo loops'), [positional or keyword] output_file: Path | None = typer.Option(None, '--output', '-o', help='File to save observational VOI result')) -> None

Calculate observational VOI from PSA, study design, and bias models.

Examples

Section titled “Examples”

Calculate observational VOI from a parameter CSV and JSON study files:

.. code-block:: bash

voiage calculate-observational parameters.csv observational_study.json bias_models.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)'))
  • observational_study_design_file Path (default: typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to JSON observational study design'))
  • bias_models_file Path (default: typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to JSON bias-model specification'))
  • model str | None (default: typer.Option(None, '--model', '-m', help='Dotted path to a callable accepting ParameterSet and returning ValueArray'))
  • 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'))
  • n_outer_loops int (default: typer.Option(20, '--n-outer-loops', help='Outer Monte Carlo loops'))
  • output_file Path | None (default: typer.Option(None, '--output', '-o', help='File to save observational VOI result'))

Returns: None