connectors.hiv_sti
connectors.hiv_sti
Syphilis-HIV connector for running coinfection analyses
Classes
| Name | Description |
|---|---|
| hiv_bv | Connector for HIV-bacterial vaginosis coinfection interaction. |
| hiv_ct | Connector for HIV-chlamydia coinfection interaction. |
| hiv_ng | Connector for HIV-gonorrhea coinfection interaction. |
| hiv_syph | Connector for bidirectional HIV-syphilis coinfection interactions. |
| hiv_tv | Connector for HIV-trichomoniasis coinfection interaction. |
hiv_bv
connectors.hiv_sti.hiv_bv(hiv_module, bv_module, pars=None, **kwargs)Connector for HIV-bacterial vaginosis coinfection interaction.
Extends hiv_simplebv to use the CST-IV vaginal microbiome state (rather than a simple infected flag) to determine which agents receive increased HIV susceptibility (default 2x) and transmissibility (default 2x).
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| hiv_module | The HIV disease module instance. | required | |
| bv_module | The BV disease module instance. | required | |
| pars | dict | Optional parameter overrides. | None |
hiv_ct
connectors.hiv_sti.hiv_ct(hiv_module, ct_module, pars=None, **kwargs)Connector for HIV-chlamydia coinfection interaction.
Models how chlamydia infection modifies susceptibility to HIV acquisition. The default relative susceptibility multiplier is 1 (no effect), serving as a placeholder for user-defined values.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| hiv_module | The HIV disease module instance. | required | |
| ct_module | The chlamydia disease module instance. | required | |
| pars | dict | Optional parameter overrides. | None |
hiv_ng
connectors.hiv_sti.hiv_ng(hiv_module, ng_module, pars=None, **kwargs)Connector for HIV-gonorrhea coinfection interaction.
Models how gonorrhea increases both susceptibility to HIV acquisition (default 1.2x) and HIV transmissibility (default 1.2x).
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| hiv_module | The HIV disease module instance. | required | |
| ng_module | The gonorrhea disease module instance. | required | |
| pars | dict | Optional parameter overrides. | None |
hiv_syph
connectors.hiv_sti.hiv_syph(hiv_module, syphilis_module, pars=None, **kwargs)Connector for bidirectional HIV-syphilis coinfection interactions.
Models how syphilis increases susceptibility to HIV (default 2.67x) and HIV transmissibility (1.2x), and how HIV/AIDS status can modify syphilis susceptibility and transmissibility.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| hiv_module | The HIV disease module instance. | required | |
| syphilis_module | The syphilis disease module instance. | required | |
| pars | dict | Optional parameter overrides for relative susceptibility and transmissibility multipliers. | None |
hiv_tv
connectors.hiv_sti.hiv_tv(hiv_module, tv_module, pars=None, **kwargs)Connector for HIV-trichomoniasis coinfection interaction.
Models how trichomoniasis increases susceptibility to HIV acquisition (default 1.5x). Effect is unidirectional: trichomoniasis affects HIV susceptibility only.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| hiv_module | The HIV disease module instance. | required | |
| tv_module | The trichomoniasis disease module instance. | required | |
| pars | dict | Optional parameter overrides. | None |