PSLmodels / OG-UK

An overlapping generations model to simulate fiscal policy the United Kingdom.
https://pslmodels.github.io/OG-UK
Other
6 stars 7 forks source link

Update documentation #48

Closed rickecon closed 2 years ago

rickecon commented 2 years ago

This PR updates the documentation for OG-UK, including fixing the references to the United States, U.S. data, and the Tax-Calculator microsimulation model as noted in Issue #44. This PR does the following.

cc: @jdebacker @nikhilwoodruff

jdebacker commented 2 years ago

Thanks @rickecon!

codecov[bot] commented 2 years ago

Codecov Report

Merging #48 (99ff935) into main (e08994c) will decrease coverage by 0.78%. The diff coverage is n/a.

@@            Coverage Diff             @@
##             main      #48      +/-   ##
==========================================
- Coverage   63.94%   63.15%   -0.79%     
==========================================
  Files           4        6       +2     
  Lines         147      323     +176     
==========================================
+ Hits           94      204     +110     
- Misses         53      119      +66     
Flag Coverage Δ
unittests 63.15% <ø> (-0.79%) :arrow_down:

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
oguk/get_micro_data.py 85.29% <ø> (+13.23%) :arrow_up:
oguk/tests/test_get_micro_data.py 82.14% <ø> (-5.36%) :arrow_down:
setup.py 0.00% <ø> (ø)
oguk/calibrate.py 46.66% <0.00%> (ø)
examples/run_oguk.py 57.35% <0.00%> (ø)
oguk/tests/test_run_example.py 93.33% <0.00%> (+60.00%) :arrow_up:

Continue to review full report at Codecov.

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

rickecon commented 2 years ago

@jdebacker. This PR is now ready for review. Since the first set of documentation commits described in the first comment of this thread, I made the following changes to the GH Action .yml files:

Regarding the current set of CI tests:

rickecon commented 2 years ago

@jdebacker @nikhilwoodruff. This PR is ready for final review once all tests pass (except for versioning and codecov).