Jmafoster1/visualisation

[jmafoster1]

This PR adds a visualisation dashboard to the CTF to serve as a nice pretty GUI. (Sorry it ended up being a bit of a monster PR!)

Closes #411

If you want to see the dashboard in action, check out this branch, install the dependencies to a virtual environment of your choice, and run causal-testing dashboard. You can then navigate to https://localhost:5006 and "upload" use dag/data from examples.

Main changes

• Moved visualisation code out of abstract_discovery.py and into a separate dedicated visualisation package
• Expanded this out into an entire visualisation dashboard package
• Moved effect_direction into CausalTestResult class. Ideally, this would be part of EffectEstimate, but that leads to circular imports with CausalEffect :(
• Bug fix on NoEffect estimate and making the other causal effects more consistent and robust
• Renamed EffectEstimate.value to EffectEstimate.effect_estimate (this touches a lot of files)
• Visualisation and dashboard tutorial.

[github-actions]

🦙 MegaLinter status: ⚠️ WARNING

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
⚠️ PYTHON	black	35		1	1.21s
✅ PYTHON	pylint	35		0	7.29s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by

[codecov]

Codecov Report

❌ Patch coverage is 99.74555% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 97.94%. Comparing base (b7c8e1e) to head (7188c3d).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
causal_testing/__main__.py	93.33%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #403      +/-   ##
==========================================
- Coverage   98.06%   97.94%   -0.13%     
==========================================
  Files          26       29       +3     
  Lines        1605     1898     +293     
==========================================
+ Hits         1574     1859     +285     
- Misses         31       39       +8     

Files with missing lines	Coverage Δ
causal_testing/causal_testing_framework.py	100.00% <100.00%> (ø)
causal_testing/discovery/abstract_discovery.py	98.36% <ø> (-0.70%)	⬇️
causal_testing/discovery/hill_climber_discovery.py	90.19% <100.00%> (ø)
causal_testing/estimation/effect_estimate.py	100.00% <100.00%> (ø)
causal_testing/testing/causal_effect.py	97.56% <100.00%> (ø)
causal_testing/testing/causal_test_case.py	100.00% <100.00%> (ø)
causal_testing/testing/causal_test_result.py	100.00% <100.00%> (ø)
causal_testing/testing/data_adequacy.py	100.00% <100.00%> (ø)
causal_testing/visualisation/geometry.py	100.00% <100.00%> (ø)
causal_testing/visualisation/testing_dashboard.py	100.00% <100.00%> (ø)
... and 2 more

... and 1 file with indirect coverage changes

---

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 373a413...7188c3d. Read the comment docs.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[jmafoster1]

Right, this should be fine now. Patch coverage is 100%, but Codecov sometimes gets confused when you move/delete code that was previously covered, which is what's happened here.

[jmafoster1]

TODO: Double check the kurtosis interpretation ("suspiciously stable"/"suspiciously unstable") before merging

See: https://fastercapital.com/content/Kurtosis--Kurtosis--Peeking-into-the-Tails-of-Normal-Distribution.html#Leptokurtic--Mesokurtic--and-Platykurtic-Distributions

EDIT: I think it's fine as is

[SylviaWhittle]

A cursory look through, seems good, flagged a few things and we sorted them together. 😄

[jmafoster1]

Thanks for such a thorough review! There might be a couple of smaller PRs in the next couple of weeks as I fix #416 #417 and #420, but this should work fine for now :)