campaign_screening#
- class campaign_screening(product=None, prob=None, eligibility=None, **kwargs)[source]#
Bases:
BaseScreening,CampaignDeliveryCampaign screening - an instance of base screening combined with campaign delivery. See base classes for a description of input arguments.
Examples:
screen1 = ss.campaign_screening(product=my_prod, prob=0.2, years=2030) # Screen 20% of the eligible population in 2020 screen2 = ss.campaign_screening(product=my_prod, prob=0.02, years=[2025,2030]) # Screen 20% of the eligible population in 2025 and again in 2030
Attributes
has_productCheck if the intervention has a product
nowShortcut to self.t.now()
statesReturn a flat list of all states
statesdictReturn a flat dictionary (objdict) of all states
tiGet the current module timestep
timevecShortcut to self.t.timevec
Methods