Skip to content
voiage

voiage.schema.TrialDesign

Specifies the design of a proposed trial for EVSI calculations.

Attributes

Section titled “Attributes”

arms : List[DecisionOption] A list of DecisionOption objects that together define the trial.

Examples

Section titled “Examples”

>>> from voiage.schema import DecisionOption, TrialDesign >>> design = TrialDesign([DecisionOption(“A”, 50), DecisionOption(“B”, 50)]) >>> design.total_sample_size 100

Raises

Section titled “Raises”

InputError If arms is not a non-empty list of DecisionOption objects, or if any of the arm names are duplicated.

Methods

Section titled “Methods”

to_dict

Section titled “to_dict”
to_dict([positional or keyword] self: None = None) -> dict[str, object]

Serialize the trial design to a dictionary.

Parameters:

  • self

Returns: dict[str, object]

from_dict

Section titled “from_dict”
from_dict([positional or keyword] cls: None = None, [positional or keyword] data: object = None) -> TrialDesign

Deserialize a trial design from a dictionary.

Parameters:

  • cls
  • data object

Returns: TrialDesign