Improve clarity of TWFE explanation #522
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Introduced γ as the global intercept to avoid overloading α
- Wrapped dataset variable names (district, year, post_treatment) in \text{} for clearer rendering
- Improved equation layout with consistent notation and salmon labels
- Revised explanatory bullets for consistency with updated notation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
drbenvincent
requested changes
Aug 28, 2025
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #522 +/- ##
=======================================
Coverage 95.19% 95.19%
=======================================
Files 28 28
Lines 2457 2457
=======================================
Hits 2339 2339
Misses 118 118 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…term of the banking dataset notebook
|
Hey @drbenvincent , dont know how I missed that! I've fixed the "" if you want to check. |
drbenvincent
approved these changes
Aug 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addressed issue #516 by improving the TWFE explanation in the
did_pymc_banks.ipynbnotebook.Changes made
Introduced$\gamma$ as the global intercept term to avoid overloading $\alpha$ .
Updated equation to use \text{} for dataset variable names (district, year, post_treatment) to improve readability and rendering.
Revised bullet-point explanations to match the updated notation and ensure consistency (e.g.,$i^{\text{th}}$ instead of $i^{th}$ ).
Clarified distinction between parameters ($\alpha$ , $\beta$ , $\gamma$ , $\Delta$ ) and observed covariates (district, year, post_treatment).
These changes improve equation rendering, remove contradictory notation around$\alpha$ , and make the explanation easier to follow for users who are new to TWFE models
📚 Documentation preview 📚: https://causalpy--522.org.readthedocs.build/en/522/