Release Schedule

[TomMaullin]

To convert the code in it's current state into a working toolbox the following steps must be enacted:

• Rehaul: All code must be restructured into user-friendly functions and the repo must meet pip guidelines.
• Testing: Unit tests must be written for all functions and continuous integration must be established.
• Profiling: Once the above have been done, everything will be very slow. Extensive profiling will be needed to resolve this. It is likely as well that speed improvements can be made for the single excursion setting.
• 3D: All code must be extended to work in 3D and then NIFTI input must be considered. Memory management must then be handled.
• Simulations: The rehaul will have destroyed time efficiency for the simulation scripts (which largely relied on running many analyses concurrently for speed). In addition, many of the simulation scripts required obscure tweaks to the codebase which shouldn't be included in a user-end version of the code as they would be redundant (e.g. tests of variants which performed worse etc). These will have to be rewritten entirely.
• Cohen's d: Once everything else is done, we can implement Cohen's d.
• CRs for peaks: Once all of the above is done, peaks can be implemented.

[TomMaullin]

Update: Following PR #2 there are now Cohen's D CRs implemented, as well as a major rehaul of the code and 3D implementation.