Tidy up code - Githubissues

alan-turing-institute / QUIPP-collab

Collaboration on the QUIPP project

1 stars 1 forks source link

Tidy up code #118

Open gmingas opened 4 years ago

gmingas commented 4 years ago

Priorities:

[ ] Make sure paper runs and figures are reproducible
[ ] Make sure it is easy for new users to run the pipeline with the existing run-input files and new ones they might want to add. (documentation, requirements files, etc should be up to date on master)
[ ] Add full pipeline tests for main synthetic methods, i.e. PATECT-GAN, PrivBayes, Synthpop, bootstrap, CTGAN
[ ] Remove framingham
[ ] https://github.com/alan-turing-institute/QUIPP-pipeline/issues/69

Secondary:

[ ] Add tests for individual methods, all their public functions, etc.
[ ] Fix any PEP8 issues using pylint, pyflakes, pycodestyle, etc
[ ] Possibly use black to automatically format code and make it uniform?
[ ] Add pycodestyle to CI?
[ ] Consistent and not-too-verbose console output
[x] Break down large chunks of code to methods
[x] Remove unnecessary comments and commented out code
[x] Add more detailed docstrings to all public methods

OscartGiles commented 3 years ago

Related to https://github.com/alan-turing-institute/QUIPP-feature-importance-plots/issues/42