cleverly.RegimeContrast

class cleverly.RegimeContrast(regimens: Any, reference: str | None = None, horizons: Sequence[int] | None = None)

Compare each declared regimen against one reference regimen.

Parameters:

regimensAny

Point-treatment interventions or longitudinal regimens. On a point-treatment design, a sequence of treatment levels and regimes, such as (0, Static(1)). CausalStudy.identify refuses a Shift or an Incremental here.

referencestr or None

Reference regimen label. None uses the first regimen.

horizonssequence of int or None

Follow-up times to report for a longitudinal outcome.

See also

RegimeMean

The regimen means this contrast is taken between.

ATE

The same comparison when treatment is given once.

cleverly.LongitudinalTreatment

The design a regimen is declared against.

Examples

Two static longitudinal regimens, compared against never treating:

>>> from cleverly import RegimeContrast
>>> estimand = RegimeContrast(
...     regimens={"always": 1, "never": 0}, reference="never"
... )
>>> estimand.reference
'never'

Methods

Attributes

RegimeContrast.definition: str = 'contrast of each regime against the reference'

RegimeContrast.horizons: Sequence[int] | None = None

RegimeContrast.name: str = 'ate_regime'

RegimeContrast.reference: str | None = None

RegimeContrast.regimens: Any