SIESTA-eu / wp15

work package 15, use case 2
0 stars 2 forks source link

The participants.json data dictionary is not copied along with the tsv #29

Closed robertoostenveld closed 3 months ago

robertoostenveld commented 3 months ago

I followed the instructions for use case 2.1

(venv) roboos@mentat001s> scramble input scrambled stub
Creating BIDS stub data in: /project/3011231.02/siesta/usecase-2.1/scrambled
--> /project/3011231.02/siesta/usecase-2.1/scrambled/CHANGES                                                                                                                                               
--> /project/3011231.02/siesta/usecase-2.1/scrambled/README                                                                                                                                                
--> /project/3011231.02/siesta/usecase-2.1/scrambled/dataset_description.json                                                                                                                              
--> /project/3011231.02/siesta/usecase-2.1/scrambled/participants.json                                                                                                                                     
--> /project/3011231.02/siesta/usecase-2.1/scrambled/participants.tsv                                                                                                                                      
Writing: dataset_description.json -> /project/3011231.02/siesta/usecase-2.1/scrambled                                                                                                                      
Copying: README -> /project/3011231.02/siesta/usecase-2.1/scrambled
Copying: CHANGES -> /project/3011231.02/siesta/usecase-2.1/scrambled

(venv) roboos@mentat001s> scramble input scrambled tsv permute -s participants.tsv
Saving: /project/3011231.02/siesta/usecase-2.1/scrambled/participants.tsv                                                                                                                                  

(venv) roboos@mentat001s> ll scrambled/
total 60
-rw-r--r-- 1 roboos megmethods    47 Aug 16 12:38 CHANGES
-rw-r--r-- 1 roboos megmethods   891 Aug 16 12:38 README
-rw-r--r-- 1 roboos megmethods  1050 Aug 16 12:38 dataset_description.json
-rw-r--r-- 1 roboos megmethods     0 Aug 16 12:38 participants.json
-rw-r--r-- 1 roboos megmethods 45809 Aug 16 12:38 participants.tsv

(venv) roboos@mentat001s> ll input/
total 96
-rw-r--r-- 1 roboos megmethods    47 Jun 13  2022 CHANGES
-rw-r--r-- 1 roboos megmethods   891 Jun 13  2022 README
-rw-r--r-- 1 roboos megmethods   727 Jun 13  2022 dataset_description.json
-rw-r--r-- 1 roboos megmethods 39425 Jun 13  2022 participants.json
-rw-r--r-- 1 roboos megmethods 39886 Jun 13  2022 participants.tsv

The input/participants.json contains the explanation and levels of the columns in the participants.tsv. The scrambled/participants.json is empty, which means that Data Users would not be able to correctly interpret the dataset on which they have to develop their analysis pipeline.

robertoostenveld commented 3 months ago

When I follow the instructions for use case 2.2, the participants.json is copied properly along.

robertoostenveld commented 3 months ago

@marcelzwiers I suspect that it is only the instruction at https://github.com/SIESTA-eu/wp15/blob/main/usecase-2.1/README.md#scrambled-data that needs to be updated. Is it enough if I do scramble input scrambled json?

edit: no, that is not sufficient. But I found it, I need to tell which fields to preserve.