tlo.methods.epi module ====================== .. automodule:: tlo.methods.epi .. autoclass:: Epi Bases: :class:`tlo.core.Module` **PARAMETERS:** .. list-table:: :widths: 25 25 50 :header-rows: 1 * - Item - Type - Description * - baseline_coverage - DATA_FRAME - baseline vaccination coverage (all vaccines) * - vaccine_schedule - SERIES - vaccination schedule applicable from 2018 onwards * - prob_facility_level_for_vaccine - LIST - The probability of going to each facility-level (0 / 1a / 1b / 2) for child having vaccines given through childhood immunisation schedule. The probabilities must sum to 1.0 **PROPERTIES:** .. list-table:: :widths: 25 25 50 :header-rows: 1 * - Item - Type - Description * - va_bcg - INT - number of doses of BCG vaccination * - va_opv - INT - number of doses of OPV vaccine received * - va_dtp - INT - number of doses of DTP vaccine received * - va_hib - INT - number of doses of Hib vaccine received * - va_hep - INT - number of doses of HepB vaccine received (infant series) * - va_pneumo - INT - number of doses of pneumococcal vaccine received * - va_rota - INT - number of doses of rotavirus vaccine received * - va_measles - INT - number of doses of measles vaccine received * - va_rubella - INT - number of doses of rubella vaccine received * - va_hpv - INT - number of doses of hpv vaccine received * - va_td - INT - number of doses of tetanus/diphtheria vaccine received by pregnant women * - va_bcg_all_doses - BOOL - whether all doses have been received of the vaccine bcg * - va_opv_all_doses - BOOL - whether all doses have been received of the OPV vaccine * - va_dtp_all_doses - BOOL - whether all doses have been received of the DTP vaccine * - va_hib_all_doses - BOOL - whether all doses have been received of the Hib vaccine * - va_hep_all_doses - BOOL - whether all doses have been received of the HepB vaccine (infant series) * - va_pneumo_all_doses - BOOL - whether all doses have been received of the pneumococcal vaccine * - va_rota_all_doses - BOOL - whether all doses have been received of the rotavirus vaccine * - va_measles_all_doses - BOOL - whether all doses have been received of the measles vaccine * - va_rubella_all_doses - BOOL - whether all doses have been received of the rubella vaccine * - va_hpv_all_doses - BOOL - whether all doses have been received of the HPV vaccine * - va_td_all_doses - BOOL - whether all doses have been received of the tetanus/diphtheria vaccine **Class attributes:** INIT_DEPENDENCIES : {'Demography', 'HealthSystem'} METADATA : {} **Functions (defined or overridden in class Epi):** .. automethod:: __init__ .. automethod:: read_parameters .. automethod:: initialise_population .. automethod:: initialise_simulation .. automethod:: on_birth .. automethod:: report_daly_values .. automethod:: increment_dose .. automethod:: get_item_codes .. autoclass:: HpvScheduleEvent Bases: :class:`tlo.events.RegularEvent`, :class:`tlo.events.Event`, :class:`tlo.events.PopulationScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class HpvScheduleEvent):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: HsiBaseVaccine Bases: :class:`tlo.methods.hsi_event.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Class attributes:** EXPECTED_APPT_FOOTPRINT : __annotations__ : {} **Functions (defined or overridden in class HsiBaseVaccine):** .. automethod:: __init__ .. automethod:: treatment_id .. automethod:: apply .. autoclass:: HSI_BcgVaccine Bases: :class:`tlo.methods.epi.HsiBaseVaccine`, :class:`tlo.methods.hsi_event.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class HSI_BcgVaccine):** .. automethod:: treatment_id .. automethod:: apply .. autoclass:: HSI_opv Bases: :class:`tlo.methods.epi.HsiBaseVaccine`, :class:`tlo.methods.hsi_event.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class HSI_opv):** .. automethod:: treatment_id .. automethod:: apply .. autoclass:: HSI_DtpHibHepVaccine Bases: :class:`tlo.methods.epi.HsiBaseVaccine`, :class:`tlo.methods.hsi_event.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class HSI_DtpHibHepVaccine):** .. automethod:: treatment_id .. automethod:: apply .. autoclass:: HSI_RotaVaccine Bases: :class:`tlo.methods.epi.HsiBaseVaccine`, :class:`tlo.methods.hsi_event.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class HSI_RotaVaccine):** .. automethod:: treatment_id .. automethod:: apply .. autoclass:: HSI_PneumoVaccine Bases: :class:`tlo.methods.epi.HsiBaseVaccine`, :class:`tlo.methods.hsi_event.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class HSI_PneumoVaccine):** .. automethod:: treatment_id .. automethod:: apply .. autoclass:: HSI_MeaslesRubellaVaccine Bases: :class:`tlo.methods.epi.HsiBaseVaccine`, :class:`tlo.methods.hsi_event.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class HSI_MeaslesRubellaVaccine):** .. automethod:: treatment_id .. automethod:: apply .. autoclass:: HSI_HpvVaccine Bases: :class:`tlo.methods.epi.HsiBaseVaccine`, :class:`tlo.methods.hsi_event.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class HSI_HpvVaccine):** .. automethod:: treatment_id .. automethod:: apply .. autoclass:: HSI_TdVaccine Bases: :class:`tlo.methods.epi.HsiBaseVaccine`, :class:`tlo.methods.hsi_event.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class HSI_TdVaccine):** .. automethod:: treatment_id .. automethod:: apply .. autoclass:: EpiLoggingEvent Bases: :class:`tlo.events.RegularEvent`, :class:`tlo.events.Event`, :class:`tlo.events.PopulationScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class EpiLoggingEvent):** .. automethod:: __init__ .. automethod:: apply