CondomUsageProbabilityChanger

The CondomUsageProbabilityChanger node intervention class allows the user to change the probability that a condom would be used during a coital act for a particular relationship type in a node. This intervention overrides the Condom_Usage_Probablility Sigmoid in the Demographics file that typically determines this probability. Note, this intervention does not expire; it causes an existing intervention to be removed. Hence, to reset the parameter, the user should submit a second intervention with the original value. This change impacts the relationships one time step after it was distributed.

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
Disqualifying_Properties	array of strings	NA	NA	[]	A list of NodeProperty key:value pairs that causes the intervention not to be distributed to the node or aborted (stopped before it could be applied). See NodeProperties and IndividualProperties parameters for more information.	{ "Disqualifying_Properties": [ "HasHealthCare:YES" ] }
Dont_Allow_Duplicates	boolean	0	1	0	If a node’s container has an intervention, set to true (1) to prevent it from receiving another copy of the intervention. Supported by all intervention classes.	{ "Dont_Allow_Duplicates": 0 }
Intervention_Name	string	NA	NA	CondomUsageProbabilityChanger	The optional name used to refer to this intervention as a means to differentiate it from others that use the same class.	{ "Intervention_Config": { "Intervention_Name": "My_Probability_Changer", "class": "CondomUsageProbabilityChanger" } }
New_Property_Value	string	NA	NA	“”	An optional NodeProperty key:value pair that will be assigned when the intervention is applied. See NodeProperties and IndividualProperties parameters for more information.	{ "New_Property_Value": "HasHealthCare:YES" }
Overriding_Condom_Usage_Probability	json object	NA	NA	NA	The new sigmoid to use when determining the probability that a condom is used during a coital act within the specified relationship type. This overrides the Condom_Usage_Probablility for the relationship type as defined in the Demographics file.	{ "class": "CondomUsageProbabilityChanger", "Relationship_Type": "INFORMAL", "Overriding_Condom_Usage_Probability": { "Min": 1, "Max": 1, "Mid": 2000, "Rate": 1 } }
Relationship_Type	enum	NA	NA	TRANSITORY	Change the behavior of the relationships for this type of relationship in this node. Possible values are: TRANSITORY INFORMAL MARITAL COMMERCIAL	{ "Overriding_Condom_Usage_Probability": { "Max": 1, "Mid": 2000, "Min": 1, "Rate": 1 }, "Relationship_Type": "INFORMAL", "class": "CondomUsageProbabilityChanger" }

{
    "Events": [
        {
            "class": "CampaignEvent",
            "Start_Day": 720,
            "Nodeset_Config": {
                "class": "NodeSetAll"
            },
            "Event_Coordinator_Config": {
                "class": "StandardInterventionDistributionEventCoordinator",
                "Intervention_Config": {
                    "class": "CondomUsageProbabilityChanger",
                    "Intervention_Name":"CondomUsageProbabilityChanger-INFORMAL",
                    "Relationship_Type": "INFORMAL",
                    "COMMENT1": "Set every INFORMAL coital act to USE condoms",
                    "Overriding_Condom_Usage_Probability" :
                    {
                        "Min": 1.0,
                        "Max": 1.0,
                        "Mid": 2000,
                        "Rate": 1
                    }
                }
            }
        }
    ],
    "Use_Defaults": 1
}