Skip to content

New docs example of Comparative Interrupted Time Series #594

@drbenvincent

Description

@drbenvincent
  • We can use the existing InterruptedTimeSeries class. But if we add in one (or more) control units as predictors then we essentially have Comparative Interrupted Time Series (CITS).
  • See @juanitorduz 's example blog post, which could serve as the basis for a new docs page. This could be done using the existing InterruptedTimeSeries class and the formula treated_scaled ~ 1 + control_scaled. Note: the blog post cites (and is partially based on the paper "Estimating Ad Effectiveness using Geo Experiments in a Time-Based Regression Framework" https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/45950.pdf)
  • Highlight the similarities and differences to regular interrupted time series (no control units in predictors) and also synthetic control (no sum to 1 constraint, can have intercept).
  • To be clear, when predictors are not control units, then we have regular ITS. When we have one of more control units in the predictor list then we have CITS.
  • An acceptable PR would add another docs page in the concise style of our existing docs, but focused on the example in @juanitorduz 's blog post. It should be concise and to the point, but also approachable and clear. It should emphasise use of the existing InterruptedTimeSeries class and educate the reader on the similarities and differences between ITS, CITS, and SC.
  • No changes to code or tests are required here.
  • Jaun is happy for this docs page to be based on his blog post. Data is available here https://github.com/juanitorduz/website_projects/blob/master/data/zipcodes_data.csv and the data generating process (code to generate the data) is here https://github.com/juanitorduz/website_projects/blob/master/Python/zipcode_data.py. But I don't think we need to look at this, we can just use the saved csv.
  • Maybe we want to port that csv file into CausalPy and add it into the data folder. We would in fact have to update load_data in datasets.py and we should add an attribution in the docstring with a link back to Jaun's blog post URL.
  • The new docs page should be added into the existing Interrupted Time Series section in the docs.
  • The title of the notebook should be "Geo-Experimentation with Comparative Interrupted Time Series". The introduction should obviously make clear that the example is based on Juan's blog post.

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions