products
Define Typhoid-specific products used with typhoid interventions.
Classes
| Name | Description |
|---|---|
| blocking_vaccine | An Acquisition Blocking vaccine that impacts the overall probability of infection after exposure, |
| infectiousness_clearence | Reduction in infectiousness. This product is applied to acute cases only |
| infectiousness_redux | Reduction in infectiousness. This product is applied to acute cases only |
| typhoid_test | This product can be used to mimic a blood culture, or rapid antobody tests. |
| typhoid_vaccine | Create a vaccine product that affects the probability of infection. |
blocking_vaccine
products.blocking_vaccine(pars=None, *args, **kwargs)An Acquisition Blocking vaccine that impacts the overall probability of infection after exposure, by modifying the ‘susceptibility level’ state (typhoid.immunity). If the immunity level is 0, then the agen can’t acquire an infection, if the level is 1.0, it can acquire the infection – also depends on other factors.
Methods
| Name | Description |
|---|---|
| administer | Apply the vaccine to the requested uids. |
administer
products.blocking_vaccine.administer(people, uids)Apply the vaccine to the requested uids.
infectiousness_clearence
products.infectiousness_clearence(pars=None, **kwargs)Reduction in infectiousness. This product is applied to acute cases only and results in a reduction or blocking in shedding.
infectiousness_redux
products.infectiousness_redux(pars=None, **kwargs)Reduction in infectiousness. This product is applied to acute cases only and results in a reduction or blocking in shedding.
typhoid_test
products.typhoid_test(pars=None, *args, **kwargs)This product can be used to mimic a blood culture, or rapid antobody tests. The main parameter is sensitivity: the probability of someone who is infected tests positive (true positives).
Methods
| Name | Description |
|---|---|
| administer | Apply the diagnostic test to the requested uids. Assumes the requested |
administer
products.typhoid_test.administer(people, uids)Apply the diagnostic test to the requested uids. Assumes the requested uids are of agents who are infected.
typhoid_vaccine
products.typhoid_vaccine(pars=None, *args, **kwargs)Create a vaccine product that affects the probability of infection.
The vaccine can be either “leaky”, in which everyone who receives the vaccine receives the same amount of protection (specified by the efficacy parameter) each time they are exposed to an infection. The alternative (leaky=False) is that the efficacy is the probability that the vaccine “takes”, in which case that person is 100% protected (and the remaining people are 0% protected).
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| efficacy | float | efficacy of the vaccine (0<=efficacy<=1) | required |
| leaky | bool | see above | required |