Skip to content
voiage

voiage.cli.calculate_enbs

calculate_enbs

Section titled “calculate_enbs”
calculate_enbs([positional or keyword] evsi_input: str = typer.Option(..., '--evsi', help='EVSI value or path to a file containing a numeric EVSI result'), [positional or keyword] research_cost: float = typer.Option(..., '--research-cost', help='Total cost of the proposed research'), [positional or keyword] output_file: Path | None = typer.Option(None, '--output', '-o', help='File to save ENBS result')) -> None

Calculate Expected Net Benefit of Sampling (ENBS).

Examples

Section titled “Examples”

Calculate ENBS from an EVSI value and research cost:

.. code-block:: bash

voiage calculate-enbs –evsi 12.5 –research-cost 10.0

Parameters:

  • evsi_input str (default: typer.Option(..., '--evsi', help='EVSI value or path to a file containing a numeric EVSI result'))
  • research_cost float (default: typer.Option(..., '--research-cost', help='Total cost of the proposed research'))
  • output_file Path | None (default: typer.Option(None, '--output', '-o', help='File to save ENBS result'))

Returns: None