cleverly.IncrementalEffect#

class cleverly.IncrementalEffect(interventions: Sequence[Incremental], reference: str | None = None, horizons: Sequence[int] | None = None)[source]#

Compare incremental propensity-score interventions.

Parameters:

interventionssequence of Incremental: Odds multipliers to compare.
referencestr or None: Reference intervention label. None uses the first intervention.
horizonssequence of int or None: Follow-up times to report for a longitudinal outcome, as for IncrementalMean.

See also

IncrementalMean: The intervention means this contrast is taken between.
cleverly.interventions.Incremental: The odds multiplier an intervention applies.
ATE: The same comparison for a treatment set to a fixed level.

Examples

Double the odds of treatment, and compare that against halving them:

>>> from cleverly import IncrementalEffect
>>> from cleverly.interventions import Incremental
>>> estimand = IncrementalEffect(
...     interventions=[
...         Incremental(delta=0.5, name="halved"),
...         Incremental(delta=2.0, name="doubled"),
...     ],
...     reference="halved",
... )
>>> estimand.reference
'halved'

Methods#

Attributes#

IncrementalEffect.definition: str = 'contrast of incremental propensity interventions'#

IncrementalEffect.horizons: Sequence[int] | None = None#

IncrementalEffect.name: str = 'ate_ipsi'#

IncrementalEffect.reference: str | None = None#

IncrementalEffect.interventions: Sequence[Incremental]#