UpDownGeoLiftSimulation#

class causalpy.data.simulate_data.UpDownGeoLiftSimulation[source]#

A reproducible three-arm geo experiment with known potential outcomes.

Spend frames have a common time index and (geo, channel) columns. Revenue and effect frames have one column per geo. Spend and revenue are simulated USD per week, recorded in each frame’s attrs['unit'].

Methods

Attributes

`revenue`
`no_intervention`
`effects`
`spend_baseline`
`spend_planned`
`spend_realized`
`arms`
`treatment_time`
`tested_channel`

__init__(revenue, no_intervention, effects, spend_baseline, spend_planned, spend_realized, arms, treatment_time, tested_channel)#

Parameters:

revenue (DataFrame)
no_intervention (DataFrame)
effects (DataFrame)
spend_baseline (DataFrame)
spend_planned (DataFrame)
spend_realized (DataFrame)
arms (dict[str, list[str]])
treatment_time (Timestamp)
tested_channel (str)

Return type:

None

classmethod __new__(*args, **kwargs)#