Endometrial cancer (EC)

Endometrial cancer package.

class miscore.processes.EC(hazard, age_factors, dwell_hyperplasia, dwell_preclinical, cure, time_to_death, onset_method='before_oc', name='ec')[source]

This process simulates Endometrial cancer.

Data are provided in the mod:~miscore.processes.ec.data module. Only the hazard, onset_method, and name parameters may be modified. Use of custom values for any of the other parameters (age_factors, dwell_hyperplasia, dwell_preclinical, cure, or time_to_death) is prohibited if the model is to be designated as “MISCAN” or “MISCAN-Endometrium”. Refer to the license for further conditions and restrictions.

Parameters:

  • hazard (float) – The individual hazard.

  • age_factors (Dict[str, Sequence[Tuple[SupportsFloat, SupportsFloat]] | Series]) – Age factors determining the age of each onset, both for ‘without_atypia’ and ‘with_atypia’. This parameter is interpreted as a piecewise linear function.

  • dwell_hyperplasia (Dict[str, Dict[str, float]]) – The dwelling time in the hyperplasia state is Weibull distributed. This parameter should contain the parameters of these distributions for each type (‘without_atypia’ and ‘with_atypia’).

  • dwell_preclinical (Dict[str, float]) – The dwelling time in the preclinical state is Weibull distributed. This parameter should contain parameters that describe this distribution.

  • cure (Sequence[Tuple[SupportsFloat, SupportsFloat]] | Series) – When a lesion transitions to a clinical state, it is cured (i.e. the individual will live with the disease until death from other causes) with a certain probability depending on the current age. This parameter is interpreted as a piecewise linear functions mapping ages to probabilities.

  • time_to_death (Sequence[Tuple[SupportsFloat, SupportsFloat]] | Series) – If a cancerous lesion is not cured, an individual will die from the disease. This parameter holds the distribution from which the times to death are drawn. It will be interpreted as a piecewise linear function.

  • onset_method (Literal['before_oc', 'first']) – Each individual can develop only one lesion (with or without atypia). When this argument is set to ‘before_oc’ (the default), the lesion will be without atypia if this onset age is before the age of death by other cause and with atypia otherwise. When set to ‘first’, the lowest onset age is chosen.

  • name (str) – The name of the process. Defaults to ‘ec’.