Separation of general purpose OpenSCORE from TEETACSI variant.

DWonGH / OpenSCORE

Software for viewing and reporting EEGs according to the SCORE standard.

0 stars 0 forks source link

Separation of general purpose OpenSCORE from TEETACSI variant. #22

Open DWonGH opened 3 years ago

DWonGH commented 3 years ago

Hopefully OpenSCORE will become useful to a fairly broad community of researchers or even clinicians. At the moment, some features such as eye-tracking are not needed by general users. The complexity of OpenSCORE should be minimised to ensure its relevance. How it would it be to separate 'general purpose OpenSCORE' from 'TEETACSI OpenSCORE', e.g. by having a separate repo for TEETACSI, using this OpenSCORE repo as a submodule?

Features to consider separating, in descending order of priority:

eye tracking
sequence mode
auto-population from text reports. Actually, this could be a great feature for OpenSCORE, but it would take a bit of work to free it up from the assumptions around use of the Temple dataset (e.g. file naming and report format).

Perhaps it's best not to act on this just yet, to postpone introducing the dev complexity of managing and documenting two repos. Let me know how much of a headache you think it would be though.

d3-worgan commented 3 years ago

I was planning to at least separate the current project into 2 branches, a plain or basic OpenSCORE on the main branch, with a separate branch for TEETACSI OpenSCORE.

It shouldnt be too hard to split them, as it should be possible to comment out a line or two for the extra tool bars and menu items. To completly separate them would mean deleting a few files and functions but they should come apart pretty cleanly.

The auto-population will definatly take a bit of work and would be best to remove from the standard OpenSCORE for now I think.

I cant see much more work being on the actual OpenSCORE between now and February so if you wanted to create a fork into a separate TEETACSI im sure that wouldnt be to much of a problem.

DWonGH commented 3 years ago

OK, the two-branch approach sounds like a good halfway house for now. Please go ahead with that.

Then if we jump to a two-repo approach the OpenSCORE main branch will be ready for that.

d3-worgan commented 3 years ago

As an update, I have created a separate branch for teetacsi, and then added an OpenSCORE submodule to the TEETACSI repository. From what I can tell at the moment, this could potentially result in some manual work when adding changes to the teetcasi branch or submodules, as there might be clashes between the deleted lines of code in the main branch, and the extra code in the TEETACSI variants.

d3-worgan commented 3 years ago

Okay, I've updated some changes to the submodule in TEETACSI from OpenSCORE. It looks like using a full git merge will cause a few issues, but the git cherry-pick command seems to work and avoid problems with the submodule being out of sync. It still does not look ideal but should also avoid the need for the teetacsi branch in the OpenSCORE repo.