tlo.methods.oesophagealcancer module ==================================== .. automodule:: tlo.methods.oesophagealcancer .. autoclass:: OesophagealCancer Bases: :class:`tlo.core.Module` **PARAMETERS:** .. list-table:: :widths: 25 25 50 :header-rows: 1 * - Item - Type - Description * - init_prop_oes_cancer_stage - LIST - initial proportions in dysplasia/cancer categories for man aged 20 with no excess alcohol and no tobacco * - init_prop_dysphagia_oes_cancer_by_stage - LIST - initial proportions of those with dysplasia/cancer categories that have the symptom dysphagia * - init_prop_with_dysphagia_diagnosed_oes_cancer_by_stage - LIST - initial proportions of people that have symptom of dysphagia that have been diagnosed * - init_prop_treatment_status_oes_cancer - LIST - initial proportions of people with oesophageal dysplasia/cancer that had initiated treatment * - init_prob_palliative_care - REAL - initial probability of being under palliative care if in stage 4 * - r_low_grade_dysplasia_none - REAL - probabilty per 3 months of incident low grade oesophageal dysplasia, amongst people with no oesophageal dysplasia (men, age20, no excess alcohol, no tobacco) * - rr_low_grade_dysplasia_none_female - REAL - rate ratio for low grade oesophageal dysplasia for females * - rr_low_grade_dysplasia_none_per_year_older - REAL - rate ratio for low grade oesophageal dysplasia per year older from age 20 * - rr_low_grade_dysplasia_none_tobacco - REAL - rate ratio for low grade oesophageal dysplasia for tobacco smokers * - rr_low_grade_dysplasia_none_ex_alc - REAL - rate ratio for low grade oesophageal dysplasia for no excess alcohol * - r_high_grade_dysplasia_low_grade_dysp - REAL - probabilty per 3 months of high grade oesophageal dysplasia, amongst people with low grade dysplasia * - rr_high_grade_dysp_undergone_curative_treatment - REAL - rate ratio for high grade dysplasia for people with low grade dysplasia if had curative treatment at low grade dysplasia stage * - r_stage1_high_grade_dysp - REAL - probabilty per 3 months of stage 1 oesophageal cancer amongst people with high grade dysplasia * - rr_stage1_undergone_curative_treatment - REAL - rate ratio for stage 1 oesophageal cancer for people with high grade dysplasia if had curative treatment at high grade dysplasia stage * - r_stage2_stage1 - REAL - probabilty per 3 months of stage 2 oesophageal cancer amongst people with stage 1 * - rr_stage2_undergone_curative_treatment - REAL - rate ratio for stage 2 oesophageal cancer for people with stage 1 oesophageal cancer if had curative treatment at stage 1 * - r_stage3_stage2 - REAL - probabilty per 3 months of stage 3 oesophageal cancer amongst people with stage 2 * - rr_stage3_undergone_curative_treatment - REAL - rate ratio for stage 3 oesophageal cancer for people with stage 2 oesophageal cancer if had curative treatment at stage 2 * - r_stage4_stage3 - REAL - probabilty per 3 months of stage 4 oesophageal cancer amongst people with stage 3 * - rr_stage4_undergone_curative_treatment - REAL - rate ratio for stage 4 oesophageal cancer for people with stage 3 oesophageal cancer if had curative treatment at stage 3 * - rate_palliative_care_stage4 - REAL - prob palliative care this 3 month period if stage4 * - r_death_oesoph_cancer - REAL - probabilty per 3 months of death from oesophageal cancer mongst people with stage 4 oesophageal cancer * - rr_dysphagia_low_grade_dysp - REAL - probability per 3 months of dysphagia in a person with low grade oesophageal dysplasia * - rr_dysphagia_high_grade_dysp - REAL - rate ratio for dysphagia if have high grade oesophageal dysplasia * - r_dysphagia_stage1 - REAL - rate ratio for dysphagia if have stage 1 oesophageal cancer * - rr_dysphagia_stage2 - REAL - rate ratio for dysphagia if have stage 2 oesophageal cancer * - rr_dysphagia_stage3 - REAL - rate ratio for dysphagia if have stage 3 oesophageal cancer * - rr_dysphagia_stage4 - REAL - rate ratio for dysphagia if have stage 4 oesophageal cancer * - rp_oes_cancer_female - REAL - relative prevalence at baseline of oesophageal dysplasia/cancer if female * - rp_oes_cancer_per_year_older - REAL - relative prevalence at baseline of oesophageal dysplasia/cancer per year older than 20 * - rp_oes_cancer_tobacco - REAL - relative prevalence at baseline of oesophageal dysplasia/cancer if tobacco * - rp_oes_cancer_ex_alc - REAL - relative prevalence at baseline of oesophageal dysplasia/cancer * - sensitivity_of_endoscopy_for_oes_cancer_with_dysphagia - REAL - sensitivity of endoscopy_for diagnosis of oesophageal cancer for those with dysphagia **PROPERTIES:** .. list-table:: :widths: 25 25 50 :header-rows: 1 * - Item - Type - Description * - oc_status - CATEGORICAL - Current status of the health condition, oesophageal dysplasia. Possible values are: [none, low_grade_dysplasia, high_grade_dysplasia, stage1, stage2, stage3, stage4, ] * - oc_date_diagnosis - DATE - the date of diagnsosis of the oes_cancer (pd.NaT if never diagnosed) * - oc_date_treatment - DATE - date of first receiving attempted curative treatment (pd.NaT if never started treatment) * - oc_stage_at_which_treatment_applied - CATEGORICAL - the cancer stage at which treatment is applied (because the treatment only has an effect during the stageat which it is applied.. Possible values are: [none, low_grade_dysplasia, high_grade_dysplasia, stage1, stage2, stage3, stage4, ] * - oc_date_palliative_care - DATE - date of first receiving palliative care (pd.NaT is never had palliative care) **Class attributes:** CAUSES_OF_DEATH : {'OesophagealCancer': } CAUSES_OF_DISABILITY : {'OesophagealCancer': } INIT_DEPENDENCIES : {'SymptomManager', 'HealthSystem', 'Demography', 'Lifestyle'} METADATA : {, , , } OPTIONAL_INIT_DEPENDENCIES : {'HealthBurden'} **Functions (defined or overridden in class OesophagealCancer):** .. automethod:: __init__ .. automethod:: read_parameters .. automethod:: initialise_population .. automethod:: initialise_simulation .. automethod:: on_birth .. automethod:: on_hsi_alert .. automethod:: report_daly_values .. autoclass:: OesCancerMainPollingEvent Bases: :class:`tlo.events.RegularEvent`, :class:`tlo.events.Event`, :class:`tlo.events.PopulationScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class OesCancerMainPollingEvent):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: HSI_OesophagealCancer_Investigation_Following_Dysphagia Bases: :class:`tlo.methods.healthsystem.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Functions (defined or overridden in class HSI_OesophagealCancer_Investigation_Following_Dysphagia):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: HSI_OesophagealCancer_StartTreatment Bases: :class:`tlo.methods.healthsystem.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Functions (defined or overridden in class HSI_OesophagealCancer_StartTreatment):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: HSI_OesophagealCancer_PostTreatmentCheck Bases: :class:`tlo.methods.healthsystem.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Functions (defined or overridden in class HSI_OesophagealCancer_PostTreatmentCheck):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: HSI_OesophagealCancer_PalliativeCare Bases: :class:`tlo.methods.healthsystem.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Functions (defined or overridden in class HSI_OesophagealCancer_PalliativeCare):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: OesCancerLoggingEvent Bases: :class:`tlo.events.RegularEvent`, :class:`tlo.events.Event`, :class:`tlo.events.PopulationScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class OesCancerLoggingEvent):** .. automethod:: __init__ .. automethod:: apply