Functionality Reorganization
hansenjiang opened this issue · comments
Hansen Jiang commented
The functionality of the project currently resides in both isolated modules and within functions in modules designed to be called from the command line. For effective implementation and separation of logic they should be restructured.
- Identify purpose, structure, and location of functionality
- Reorganize by separating logic from operations
- Restructure package with clear and documented modules and subpackages
Hansen Jiang commented
Hansen Jiang commented
- For each module in
cli
(exceptrun_crop
), removed programming logic and placed in relevant base module- e.g. all logic in
cli.cleanup
was moved toutils.fileutils
, all logic incli.convolve_neighbours
toneighbours
, etc.
- e.g. all logic in
- Renamed
main
functions to corresponding module names- e.g.
cli.correct_vast.main()
moved tocorrections
and renamed tocorrections.correct_vast()
- e.g.
- Made calls to renamed functions from
cli
modules- Now, each
cli
module only runstyper
, interprets arguments, and calls functions from corresponding modules
- Now, each
Hansen Jiang commented
Successful run of cli.correct_vast
following logic separation. Likely did not break anything during separation.
Hansen Jiang commented
Marking as closed, as cli
functionality and calls formally separated in dev
branch. Documentation and organization will be added and addressed by #32.