Skip to content

Add experiment design notation docs page to new Knowledge Base section of the docs #312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Apr 5, 2024

Conversation

drbenvincent
Copy link
Collaborator

@drbenvincent drbenvincent commented Apr 2, 2024

  • In this discussion Add an Explainer section to the docs, simplify `README.md` and `index.rst` #262 I floated the idea of adding some didactic information to the docs. This PR represents my first attempt to do that.
  • It adds a new section on the left navbar, called Knowledge Base
  • And it adds a new page which runs through the tabular experiment design notation established in Shadish Cook & Campbell (2002) and Reichardt (2009).
  • Happy to have some feedback

@drbenvincent drbenvincent added the documentation Improvements or additions to documentation label Apr 2, 2024
Copy link

codecov bot commented Apr 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.10%. Comparing base (a64fc0a) to head (0db64fc).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #312   +/-   ##
=======================================
  Coverage   77.10%   77.10%           
=======================================
  Files          21       21           
  Lines        1380     1380           
=======================================
  Hits         1064     1064           
  Misses        316      316           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@juanitorduz juanitorduz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left some comments. Let mw know what you think. I think it would bring a lot of clarity to use the potential outcomes language (just a suggestion)

It would also be nice to indicate briefly after eash method how this could be done in CausalPy. I think it would be a great entrypoint for the library.

@drbenvincent
Copy link
Collaborator Author

Failing doctest seems to be some broken import in arviz, nothing internal to causalpy.

@drbenvincent
Copy link
Collaborator Author

I left some comments. Let mw know what you think. I think it would bring a lot of clarity to use the potential outcomes language (just a suggestion)

It would also be nice to indicate briefly after eash method how this could be done in CausalPy. I think it would be a great entrypoint for the library.

Thanks for the review. It's just my edit to the ANCOVA/covariate(s) which might need to be looked at I think.

For the moment I'm trying to steer clear of mentioning the potential outcomes framework, or talk about DAGS and backdoors etc. My rough goal here is to create a series of relatively self-contained knowledge base pages which are relatively focussed. So this docs page is intended to focus on the experiment design side of things, but there will be another docs page focussing on DAGS for the different quasi-experimental designs, and maybe others on the potential outcomes framework or g-computation. Similarly, I'm trying to keep some separation between the theory (in the knowledge base) and practice (in the example notebooks). It might not always be like that, but at the moment that seems like the right structure to tackle things in relatively bite-sized chunks

@juanitorduz
Copy link
Collaborator

Got it! Thanks for providing context!

@juanitorduz
Copy link
Collaborator

BTW: The test is failing because of pymc-labs/pymc-marketing#608. An arviz release will fix it.

@drbenvincent
Copy link
Collaborator Author

Remote tests still failing despite there being an arviz release (https://github.com/arviz-devs/arviz/releases/tag/v0.18.0) 12 hours ago

@drbenvincent drbenvincent merged commit 9fb2599 into main Apr 5, 2024
@drbenvincent drbenvincent deleted the design-notation-explainer branch April 5, 2024 11:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants