diff --git a/README.md b/README.md index 99399b62eb906d3d286b40366ebf8ee6f0b5d7fe..eb9a3c893ef7d47b3397ea0ee2d93018721f5252 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,17 @@ # SFB Study Checker -Checks if a certain study (given by its root folder) is conform with the [SFB standards](https://gitlab.ruhr-uni-bochum.de/sfb1280/studychecker/-/wikis/SFB-data-and-metadata-standards). This is achieved by checking the folder structure and all _meta.json_ files. -The following errors will be checked: -- *InconsitentModalityError*: Modalities change inbetween subject folder of the same session. +Checks if a certain study (given by its root folder) complies with [SFB standards](https://gitlab.ruhr-uni-bochum.de/sfb1280/studychecker/-/wikis/SFB-data-and-metadata-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. Mostly because incorrect subject folder or subject prefix selected. -- *UnknownModalityError*: Modality folder name is not standard. +- *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](https://gitlab.ruhr-uni-bochum.de/sfb1280/metaapp_2/-/wikis/MetaDataApp-Wiki/SFB-1280-metadata-fields#7-modality). + + ### 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 @@ -33,11 +35,10 @@ Input fields top down: ## 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; Otto, Tobias; Pacharra, Marlene (2024). https://gitlab.ruhr-uni-bochum.de/sfb1280/studychecker/ - -## Contact +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 <br> -If you encountered a bug, please use the built in button to automatically send a bug report with diagnostic data to our development team. +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). \ No newline at end of file