emodpy_hiv.interventions.reftracker module¶
-
emodpy_hiv.interventions.reftracker.
DistributeIVByRefTrack
(camp, Start_Day, Intervention, TVMap, node_ids=None, Event_Name='Scheduled_Campaign_Event', Property_Restrictions=None, Target_Demographic='Everyone', Target_Age_Min=0, Target_Age_Max=45625, Target_Gender='All')¶ Wrapper function to create and return a ScheduledCampaignEvent intervention. The alternative to a ScheduledCampaignEvent is a TriggeredCampaignEvent.
- Parameters
camp – emod_api.campaign object with schema_path set.
Start_Day – When to start.
Intervention – Valid intervention to be distributed together as necessary to track coverage targets.
Event_Name – Name for overall campaign event, of not functional meaning.
node_ids – Nodes to target with this intervention, return from utils.do_nodes().
Property_Restrictions – Individual Properties a person must have to receive the intervention(s).
Number_Repetitions – N/A
Timesteps_Between_Repetitions – N/A
Target_Demographic – Everyone, ExplicitAgeRanges, etc.
Target_Age_Min – Minimum age (in years).
Target_Age_Max – Maximum age (in years).
Target_Gender – All, Male, or Female.
- Returns
Schema-based smart dictionary representing a new ScheduledCampaignEvent intervention ready to be added to a campaign.
- Return type
ReadOnlyDict
-
emodpy_hiv.interventions.reftracker.
new_intervention_as_file
(camp, actual_intervention, start_day=1, filename=None)¶