TyphoidCarrierClear¶
The TyphoidCarrierClear intervention class sets the rate at which an infected individual clears their body of typhoid.
Note
Parameters are case-sensitive. For Boolean parameters, set to 1 for true or 0 for false. Minimum, maximum, or default values of “NA” indicate that those values are not applicable for that parameter.
EMOD does not use true defaults; that is, if the dependency relationships indicate that a parameter is required, you must supply a value for it. However, many of the tools used to work with EMOD will use the default values provided below.
JSON format does not permit comments, but you can add “dummy” parameters to add contextual information to your files. Any keys that are not EMOD parameter names will be ignored by the model.
The table below describes all possible parameters with which this class can be configured. The JSON example that follows shows one potential configuration.
Parameter |
Data type |
Minimum |
Maximum |
Default |
Description |
Example |
---|---|---|---|---|---|---|
Clearance_Rate |
float |
0 |
1 |
1 |
For future expansion, not currently used. |
{
"Clearance_Rate": 1
}
|
{
"Event_Coordinator_Config": {
"Intervention_Config": {
"Clearance_Rate": 0.02,
"class": "TyphoidCarrierClear"
},
"Number_Repetitions": 10,
"Timesteps_Between_Repetitions": 180,
"class": "StandardInterventionDistributionEventCoordinator"
},
"Event_Name": "Clear infection",
"Nodeset_Config": {
"class": "NodeSetAll"
},
"Start_Day": 2,
"Target_Demographic": "Everyone",
"class": "CampaignEvent"
}