emodpy_typhoid.interventions.typhoid_vaccine module¶
- emodpy_typhoid.interventions.typhoid_vaccine.new_intervention(camp, efficacy=0.82, mode='Shedding', constant_period=0, decay_constant=0, expected_expiration=0)[source]¶
Create a new TyphoidVaccine intervention with specified parameters. If you use this function directly, you’ll need to distribute the intervention with a function like ScheduledCampaignEvent or TriggeredCampaignEvent from emod_api.interventions.common.
- Parameters:
camp (Camp) – The camp to which the intervention is applied.
efficacy (float, optional) – The efficacy of the Typhoid vaccine. Default is 0.82.
mode (str, optional) – The mode of the intervention. Default is “Shedding”.
constant_period (float, optional) – The constant period of the waning effect in days. Default is 0.
decay_constant (float, optional) – The decay time constant for the waning effect. Default is 6935.0.
expected_expiration (float, optional) – The mean duration before efficacy becomes 0. If this is set to non-zero value, the constant_period and decay_constant are ignored. These are two different modes of waning.
- Returns:
A fully configured instance of the TyphoidVaccine intervention with the specified parameters.
- Return type:
TyphoidVaccine
- emodpy_typhoid.interventions.typhoid_vaccine.new_vax(camp, efficacy=0.82, mode='Acquisition', constant_period=0, decay_constant=0, expected_expiration=0, deduplication_policy='replace')[source]¶
Create a new ‘SimpleVaccine’ intervention with specified parameters. If you use this function directly, you’ll need to distribute the intervention with a function like ScheduledCampaignEvent or TriggeredCampaignEvent from emod_api.interventions.common.
- Parameters:
camp (Camp) – The camp to which the intervention is applied.
efficacy (float, optional) – The efficacy of the Typhoid vaccine. Default is 0.82.
mode (str, optional) – The mode of the intervention. Default is “Acquisition” Can also be “Transmission” or “All”.
constant_period (float, optional) – The constant period of the waning effect in days. Default is 0.
decay_constant (float, optional) – The decay time constant for the waning effect. Default is 6935.0.
expected_expiration (float, optional) – The mean duration before efficacy becomes 0. If this is set to non-zero value, the constant_period and decay_constant are ignored. These are two different modes of waning.
deduplication_policy (string) – “replace” (default) or “combine”. If giving vax to someone who already has one, based on Intervention_Name which defaults to intervention classname (“SimpleVaccine”), “replace” will purge the existing one, and “combine” will add the new one without replacement, and rely on code and configuration to calculate the combinatorix. If using “combine”, make sure you _know_ the combinatorix.
- Returns:
A fully configured instance of the SimpleVaccine intervention with the specified parameters.
- Return type:
SimpleVaccine
- emodpy_typhoid.interventions.typhoid_vaccine.new_triggered_intervention(camp, efficacy=0.82, mode='Shedding', constant_period=0, decay_constant=6935.0, start_day=1, triggers=['Births'], coverage=1.0, node_ids=None, property_restrictions_list=[], co_event=None)[source]¶
Create a new triggered TyphoidVaccine intervention based on specified parameters.
- Parameters:
camp (Camp) – The camp to which the intervention is applied.
efficacy (float, optional) – The efficacy of the Typhoid vaccine. Default is 0.82.
mode (str, optional) – The mode of the intervention. Default is “Shedding”.
constant_period (float, optional) – The constant period of the waning effect in days. Default is 0.
decay_constant (float, optional) – The decay time constant for the waning effect. Default is 6935.0.
start_day (int, optional) – The day on which the intervention starts. Default is 1.
triggers (list, optional) – List of triggers for the intervention. Default is [“Births”].
coverage (float, optional) – Demographic coverage of the intervention. Default is 1.0.
node_ids (list, optional) – List of node IDs where the intervention is applied. Default is None.
property_restrictions_list (list, optional) – List of property restrictions for the intervention. Default is an empty list.
co_event – The name of the event to be broadcast. This event name can be set in the Report_Event_Recorder_Events configuration parameter. It will be collected in ReportEventRecorder.csv with default event “VaccineDistributed”.
- emodpy_typhoid.interventions.typhoid_vaccine.new_routine_immunization(camp, efficacy=0.82, mode='Acquisition', constant_period=0, decay_constant=0, expected_expiration=0, start_day=1, child_age=270, coverage=1.0, node_ids=None, property_restrictions_list=[], co_event='VaccineDistributed')[source]¶
Create a new delayed, birth-triggered SimpleVaccine intervention based on specified parameters. Does not add to campaign.
- Parameters:
camp (Camp) – The camp to which the intervention is applied.
efficacy (float, optional) – The efficacy of the Typhoid vaccine. Default is 0.82.
mode (str, optional) – The mode of the intervention. Default is “Shedding”.
constant_period (float, optional) – The constant period of the waning effect in days. Default is 0.
decay_constant (float, optional) – The decay time constant for the waning effect. Default is 6935.0.
expected_expiration (float, optional) – The mean duration before efficacy becomes 0. If this is set to non-zero value, the constant_period and decay_constant are ignored. These are two different modes of waning.
start_day (int, optional) – The day on which the intervention starts. Default is 1.
child_age (int, optional) – The age of the person when they get the vaccine. Defaults to 9 months. Vaccines are actually distribute +/- 7 days.
coverage (float, optional) – Demographic coverage of the intervention. Default is 1.0.
node_ids (list, optional) – List of node IDs where the intervention is applied. Default is None.
property_restrictions_list (list, optional) – List of property restrictions for the intervention. Default is an empty list.
co_event – The name of the event to be broadcast. This event name can be set in the Report_Event_Recorder_Events configuration parameter. It will be collected in ReportEventRecorder.csv with default event “VaccineDistributed” if not set with other name.
- emodpy_typhoid.interventions.typhoid_vaccine.new_scheduled_intervention(camp, efficacy=0.82, mode='Shedding', constant_period=0, decay_constant=6935.0, start_day=1, coverage=1.0, node_ids=None, property_restrictions_list=[], co_event=None)[source]¶
Create a new scheduled TyphoidVaccine intervention based on specified parameters.
- Parameters:
camp (Camp) – The camp to which the intervention is applied.
efficacy (float, optional) – The efficacy of the Typhoid vaccine. Default is 0.82.
mode (str, optional) – The mode of the intervention. Default is “Shedding”.
constant_period (float, optional) – The constant period of the waning effect in days. Default is 0.
decay_constant (float, optional) – The decay time constant for the waning effect. Default is 6935.0.
start_day (int, optional) – The day on which the intervention starts. Default is 1.
coverage (float, optional) – Demographic coverage of the intervention. Default is 1.0.
node_ids (list, optional) – List of node IDs where the intervention is applied. Default is None.
property_restrictions_list (list, optional) – List of property restrictions for the intervention. Default is an empty list.
co_event – The name of the event to be broadcast. This event name can be set in the Report_Event_Recorder_Events configuration parameter. It will be collected in ReportEventRecorder.csv if set not None or “”.