home.md

@@ -10,6 +10,7 @@ title: StudyChecker
 
 
 
+
 # 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 validating all metadata files.
@@ -23,6 +24,20 @@ The following errors will be checked:
 - *NoSubjectError*: Study does not contain any subjects. Mostly because incorrect subject folder or subject prefix selected.
 - *UnknownModalityError*: Modality folder name is not standard.
 
+### GUI Usage
+![](/images/StudyChecker_tutorial.png)
+
+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. 
+
 ## Additional information
 Please check out the [projects main page](https://gitlab.ruhr-uni-bochum.de/sfb1280/studychecker/) for more details on how to use this program. You have to be **signed in** to view the rest of the project.