routine_screening#

class routine_screening(product=None, prob=None, eligibility=None, **kwargs)[source]#

Bases: BaseScreening, RoutineDelivery

Routine screening - an instance of base screening combined with routine delivery. See base classes for a description of input arguments.

Examples:

screen1 = ss.routine_screening(product=my_prod, prob=0.02) # Screen 2% of the eligible population every year
screen2 = ss.routine_screening(product=my_prod, prob=0.02, start_year=2020) # Screen 2% every year starting in 2020
screen3 = ss.routine_screening(product=my_prod, prob=np.linspace(0.005,0.025,5), years=np.arange(2020,2025)) # Scale up screening over 5 years starting in 2020

Attributes

has_product

Check if the intervention has a product

now

Shortcut to self.t.now()

states

Return a flat list of all states

statesdict

Return a flat dictionary (objdict) of all states

ti

Get the current module timestep

timevec

Shortcut to self.t.timevec

Methods