CoitalActRateChanger

The CoitalActRateChanger node intervention class allows the user to change the coital act rate for a particular relationship type in a node. This allows the user to model, for example, how an education program or other intervention might reduce the number of coital acts individuals have. This intervention overrides the Coital_Act_Rate value in the Demographics file that typically determines this rate. 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	CoitalActRateChanger	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_Rate_Changer", "class": "CoitalActRateChanger" } }
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_Coital_Act_Rate	float	0	20	0.33	The new coital act rate to use in the node for this relationship type. This overrides the Coital_Act_Rate for the relationship type as defined in the Demographics file.	{ "class": "CoitalActRateChanger", "Intervention_Name": "CoitalActRateChanger-INFORMAL", "Relationship_Type": "INFORMAL", "Overriding_Coital_Act_Rate": 0.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	{ "class": "CoitalActRateChanger", "Intervention_Name": "CoitalActRateChanger-INFORMAL", "Relationship_Type": "INFORMAL", "Overriding_Coital_Act_Rate": 0.1 }

{
    "Use_Defaults": 1,
    "Events": [{
        "class": "CampaignEvent",
        "Start_Day": 40,
        "Nodeset_Config": {
            "class": "NodeSetAll"
        },
        "Event_Coordinator_Config": {
            "class": "StandardInterventionDistributionEventCoordinator",
            "Node_Property_Restrictions": [{
                "HasAdministeredSexEducation": "YES"
            }],
            "Intervention_Config": {
                "class": "CoitalActRateChanger",
                "Intervention_Name":"CoitalActRateChanger-INFORMAL",
                "Relationship_Type": "INFORMAL",
                "Overriding_Formation_Rate": 0.1
            }
        }
    }]
}