change_initiation_prob#

class change_initiation_prob(year=None, prob_use_intercept=0.0, verbose=False, **kwargs)[source]#

Bases: Intervention

Intervention to change the probabilty of contraception use trend parameter in contraceptive choice modules that have a logistic regression model.

Parameters:
  • year (float) – The year in which this intervention will be applied

  • prob_use_intercept (float) – A number that changes the intercept in the logistic regression model

  • / (p_use = 1)

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

step()[source]#

Applies the changes to efficacy or contraceptive uptake changes if it is the specified year based on scenario specifications.