Skip to content
Snippets Groups Projects
Commit 891eb726 authored by Erik Diers's avatar Erik Diers
Browse files
parents 1fd7e248 a51a3a5d
Branches
No related tags found
No related merge requests found
# ParticipantsTSVConverter
### Purpose
This application will create _SFB_-conform meta data (_meta.json_ files) for all participants in the _participants.tsv_ file of you your study. The _meta.json files_ will include the subjects _ID_, _sex_ and _age_. Moreover it is possible to register a template _meta.json_ file, which values will be adopted into the newly created meta-files.
### 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
### Participants.tsv format
The _participants.tsv_ has to follow the this [standard](https://bids-specification.readthedocs.io/en/stable/modality-agnostic-files.html#participants-file). Moreover for the conversion at least following fields must be included:
- `participant_id`: The exact name of the subject folder. Usually this is composed of two parts: "sub-" and the _SFB code_. The _SFB code_ will be extracted and used as _Subject ID_. The _SFB code_ cannot contain hyphens.
- `sex`: Sex of the subject (_m\[ale] or f\[emale])_.
- `age`: Age of the subject (in years).
### GUI Usage
Input fields top down:
1. _Study folder:_
Selects the study folder. The study folder is the folder, which contains both the the _participants.tsv_ file and the subject folders.
2. _Use default meta.json (recommended):_
If cecked allows the user the add a template _meta.json_ file. Every newly created meta-file will adopt its values. It is highly recommended to use this feature to enlarge the richness of the _SFB-metadata_.
If not used, meta-files will be empty besides subject-_ID_, _sex_, _age_ and the name of the Study.
1. _meta.json - File chooser:_
Select the template _meta.json_ file.
3. _Convert:_
Starts _meta.json_ creation process. Once finished a pop-up message will inform the user. If subjects defined in the _participants.tsv_ are non existing, a warning message will be displayed.
**Please keep in mind that this application overwrites any already created _meta.json_ files in the subjects modality folders**
### Contact
Author: [Erik Diers](mailto:erik.diers@rub.de)
Contributor: [Marlene Pacharra](mailto:marlene.pacharra@ruhr-uni-bochum.de) and [Tobias Otto](mailto:tobias.otto@rub.de)
Questions to: INF Projekt, [sfb1280data@rub.de](mailto:sfb1280data@rub.de)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment