Skip to content
Snippets Groups Projects
Select Git revision
  • main default protected
  • v1.0
2 results
Blame Permalink
To learn more about this project, read the wiki.
README.md 3.17 KiB

SFB Study Checker

Checks if a certain study (given by its root folder) complies with SFB standards. This is achieved by checking the folder structure and validating all metadata files. The SFB Study Checker detects the following errors and draws the user's attention to them:

  • InconsitentModalityError: The modalities are inconsistent between subjects for one session.
  • InconsitentSessionError: Amount of sessions varies from subject to subject.
  • IncorrectSubjectIDInMetaDataError: Subject ID in meta.json differs from the subject folder name.
  • InvalidSessionNameError: Naming convention of the session folder invalidated.
  • NoMetaDataInSubjectError: The subject does not contain any meta.json files.
  • NoMetaDataLastLayerError: On the lowest directory no meta.json file found.
  • NoSubjectError: Study does not contain any subjects. Please check, if the correct subject folders or subject prefix was selected selected.
  • UnknownModalityError: Name of the modality folder is not contained in the SFB metadata.

Requirements

It is required to have a Java version greater or equal to 1.8.0 installed. You can download the current Java Corretto here: https://docs.aws.amazon.com/de_de/corretto/latest/corretto-11-ug/downloads-list.html
After installing Java, you should be able to launch the application by simply double-clicking it.

GUI Usage

Input fields top down:

  1. Study Base folder: Selects the study folder. The study folder is the folder, which contains the subject folders.
  2. Subject prefix: If the subject folders of the selected study use a different prefix than "sub-", click the checkbox and enter their prefix here. If the subject folders contain no shared prefix, type "." in the input field to treat all folders inside the selected study as subject. If a selected folder does not contain any subject data, errors for this folder may be ignored.
  3. Advanced subject search: Checks whether all subject prefixes match. If the study contains folders that are not inside subject folders, they will also get flagged. Disabling this option prevents that.
  4. Submit: Starts performing checks on the given study.

License and Citation

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License: https://creativecommons.org/licenses/by-sa/4.0/

Please cite as: Diers, Erik; Diers, Oliver; Pacharra, Marlene; Otto, Tobias (2024). Zenodo. https://doi.org/10.5281/zenodo.13968793

If you have any questions about the SFB Study Checker, or if you have feature requests, please contact the SFB's INF project via email at sfb1280data@rub.de
If you encounter a bug, please use the built in button to automatically send a bug report with diagnostic data to our development team.

Funding

The development of the SFB Study Checker was carried out as part of the SFB 1280 INF project, supported by the Deutsche Forschungsgemeinschaft DFG (German Research Foundation, project number 316803389).