gin commit from PC-2

New files: 393

README

@@ -0,0 +1,87 @@
+
+# Braille BCI experiment EEG experiment
+
+## Brief experiment description
+10 blind and 10 sighted subjects were using tactile P300 BCI, implemented with Alva 640 comfort Braille display.
+
+4 fingers on each hand were placed on separate Braille cells, serving as stimuli. Each stimulus was activated 10 times in random order. Participant's task was to count activations of target cell.
+
+For blind subjects, Braille proficiency was assessed with the reading test before the experiment.
+The experiment included BCI sessions with large (8 dots) and small (1 dot) stimuli.
+
+The present analysis is focused on the comparison of BCI performance for large and small stimuli in blind and sighted individuals.
+
+For more details, see our preprint at ############
+
+Complete analysis is available at https://github.com/eegdude/erp_analysis/tree/brlbci
+The scripts are designed to work with contents of sourcedata folder
+
+## Sourcedata description
+
+Per-record markup is provided in sourcedata. Per-epoch markup is calculated at preprocessing step.
+Various stimuli parameters for each epoch are descriped in events.tsv files
+
+### Per-record markup
+
+|column name |description
+|---|---|
+|  user|  user id
+|  folder|  folder with a record inside the user folder
+|  reg|  BCI mode. 'large' for large stimuli, 'small' for small |  stimuli 
+|  targets|  list of target stimuli for all learning and stimuli selection cycles
+|  fingers|  which finger corresponds to specific stimuli code.<br> right hand  0 - pinky, 1 - ring, 2 - middle, 3 - index<br>left hand  4 - index, 5 - middle, 6 - ring, 7 - pinky
+|  ecg_r_peak_direction|  1 if R-peak is up, -1 if R-peak is down, 0 or 2 if no ECG
+|  leading_hand|  'r' if right, 'l' if left
+|  ignore_events_id|  list of events to not include into analysis
+|  reading_finger|  list of fingers used for Braille reading
+|  blind|  1 if blind, 0 if sighted
+|  order|  index of the record in the experiment. Failed sessions that have not made it into the dataset are counted.
+|  blindness_age|  age of complete vision loss
+|  reading_time|  time of reading Braille text of standard informed consent
+|  braille_display_user|  1 if the subject uses Braille display in daily life
+|  daily_braille_time|  self-reported daily Braille usage, hours
+|  age|  user's age
+|  music|  1 if the subject has musical experience (except vocal), 0 if not
+|  remaining_vision|  1 if the user has residual vision, 0 if not
+|  sex|  male or female
+|  blind_years|  years passed from total vision loss
+|  congenitaly_blind|  1 if congenital blindness, 0 if acquired
+
+### Per-epoch markup
+The preprocessed dataset has some added columns, which are calculated during the preprocessing stage.
+|column name |description
+|---|---|
+|  id|  unique epoch id
+|  event|  epoch event (activated stimuli id)
+|  target|  id of current target stimuli
+|  is_target|  1 if epoch is target, 0 if not
+|  session_id|  stimuli selection cycle index inside experiment
+|  epoch_id|  epoch index inside stimuli selection cycle (from 0 to 79)
+|  ms_after_r|  milliseconds after R-peak
+|  ms_before_r|  milliseconds before next R-peak
+
+### Sourcedata folder structure
+```
+\
+└── markup.csv                               # metadata for all records
+└── user 
+    └── record
+        └── _data_$MODE__play_$TIME.npy      # Raw EEG data
+        └── _events_$MODE__play_$TIME.npy    # BCI events
+        └── _photocell_$MODE__play_$TIME.npy # sync events
+        └── Rpeaks.npy                       # preprocessed R-peaks, if availible
+```
+users are numbered from 6 to 26
+
+$MODE can be 'large' for large stimuli and 'small' for small stimuli
+
+### Preprocessed data folder structure
+```
+\
+└── markup.csv                               # metadata for all epochs, created at preprocessing stage
+└── 0.pickle                                 # pickle files, corresponding to single epochs
+
+...
+
+└── $N.pickle
+```

dataset_description.json

@@ -0,0 +1,15 @@
+{
+  "Name": "Braille BCI",
+  "BIDSVersion": "1.3.1-dev ",
+  "License": "",
+  "Authors": ["Rafael Grigoryan", "Dariya Goranskaya", "Andrey Demchinsky", "Ksenia Ryabova", "Denis Kuleshov", "Alexander Kaplan"],
+  "Acknowledgements": "",
+  "HowToAcknowledge": "",
+  "Funding": [],
+  "EthicsApprovals": "",
+  "ReferencesAndLinks": [],
+  "DatasetDOI": ""
+}
+
+
+

participants.json

@@ -0,0 +1,70 @@
+{
+    "leading_hand": {
+        "Levels": {
+            "right": "r",
+            "left": "l"
+        }
+    },
+    "reading_finger": {
+        "Description": "List of fingers used by participand for daily Braille reading, if any"
+    },
+    "blind":{
+        "Levels": {
+            "blind": "1",
+            "sighted": "0"
+        }
+    },
+    "blindness_age": {
+        "Description": "Age of complete vision loss"
+    },
+    "order": {
+        "Description": "Index of the record in the experiment. Failed sessions that have not made it into the dataset are counted."
+    },
+    "reading_time": {
+        "Description": "Time of reading Braille text of standard informed consent",
+        "Units": "Seconds"
+    },
+    "braille_display_user": {
+        "Levels":{
+            "The subject uses Braille display in daily life": "1",
+            "The subject does not use Braille display in daily life": "0"
+        }
+    },
+    "daily_braille_time": {
+        "Description": "Self-reported daily Braille usage",
+        "Units": "Hours"
+
+    },
+    "age": {
+        "Description": "User's age",
+        "Units": "Years"
+    },
+    "misuc": {
+        "Levels":{
+            "Musical experience (except vocal)": "1",
+            "No musical experience": "0"
+        }
+    },
+    "remaining_vision": {
+        "Levels":{
+            "Residual vision": "1",
+            "No residual vision": "0"
+        }
+    },
+    "sex": {
+        "Levels":{
+            "male": "male",
+            "female": "female"
+        }
+    },
+    "blind_years": {
+        "Description": "years passed from total vision loss",
+        "Units": "Years"
+    },
+    "congenitaly_blind": {
+        "Levels":{
+            "Congenital blindness": "1",
+            "Acquired blindness": "0"
+        }
+    }
+}

participants.tsv

@@ -0,0 +1,21 @@
+participant_id	leading_hand	reading_finger	blind	order	blindness_age	reading_time	braille_display_user	daily_braille_time	age	remaining_vision	sex	blind_years	congenitaly_blind
+sub-6	r	"[3,4]"	1	4	0	418	0	25	44	1	female	44	1
+sub-8	r	[4]	1	2	0	875	0	0	52	1	female	52	1
+sub-9	r	[3] 	1	3	0	1078	1	14	33	0	female	33	1
+sub-10	r	"[3,4]"	1	1	20	646	1	14	28	0	female	8	0
+sub-11	r	[3]" 	1	1	16	1400	0	0	30	1	male	14	0
+sub-12	l	"[3,4]"	1	3	0	1450	0	0	20	0	male	20	1
+sub-13	r	"[3,4]"	1	2	0	1190	0	3	44	1	male	44	1
+sub-14	r	"[4]"	1	1	16	1050	0	3	49	0	female	33	0
+sub-15	r	"[4]"	1	1	0	480	0	14	20	0	female	20	1
+sub-16	r	"[4]"	1	2	16	640	1	0	30	0	female	14	0
+sub-17	r	-1	0	1	-1	-1	-1	-1	26	-1	male	-1	-1
+sub-18	r	-1	0	3	-1	-1	-1	-1	27	-1	male	-1	-1
+sub-19	r	-1	0	3	-1	-1	-1	-1	27	-1	male	-1	-1
+sub-20	r	-1	0	2	-1	-1	-1	-1	19	-1	female	-1	-1
+sub-21	r	-1	0	4	-1	-1	-1	-1	31	-1	female	-1	-1
+sub-22	l	-1	0	3	-1	-1	-1	-1	20	-1	male	-1	-1
+sub-23	r	-1	0	2	-1	-1	-1	-1	32	-1	male	-1	-1
+sub-24	r	-1	0	2	-1	-1	-1	-1	46	-1	female	-1	-1
+sub-25	r	-1	0	4	-1	-1	-1	-1	29	-1	male	-1	-1
+sub-26	r	-1	0	3	-1	-1	-1	-1	29	-1	female	-1	-1

sourcedata/10/1/_data_large__play_14_54__24_07.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s123251984--179950f08ca23b1f316a6b418c13cefc

sourcedata/10/1/answers_large_14_54__24_07.txt

@@ -0,0 +1 @@
+зжаввгдее

sourcedata/10/2/_data_small__play_15_08__24_07.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s122470336--26bcd59084a43e5b9dbe27bd20eed691

sourcedata/10/2/answers_small_15_08__24_07.txt

@@ -0,0 +1 @@
+здабвгдед

sourcedata/11/1/_data_large__play_19_21__02_08.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s123516192--a70ab346c66b063c205fabb5a5b9f2fc

sourcedata/11/1/answers_large_19_21__02_08.txt

@@ -0,0 +1 @@
+загбваезг

sourcedata/11/3/_data_small__play_20_05__02_08.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s122582448--dbf15c3a8c8cd34488faf2c27f4eb3af

sourcedata/11/3/answers_small_20_04__02_08.txt

@@ -0,0 +1 @@
+джвбвгзжа

sourcedata/12/1/_data_small__play_14_13__06_08.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s124099880--a27da85faf0cc6bdad7ef84f7324b8c8

sourcedata/12/1/answers_small_14_13__06_08.txt

@@ -0,0 +1 @@
+дггггвббж

sourcedata/12/3/_data_large__play_15_00__06_08.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s123190440--be1aac3aa2643b6c65bcb4207e4648e2

sourcedata/12/3/answers_large_15_00__06_08.txt

@@ -0,0 +1 @@
+гвабвгдвб

sourcedata/13/2/_data_large__play_16_31__06_08.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s123637712--bbe33de1f05c9007c5925fe3c34b035a

sourcedata/13/2/answers_large_16_31__06_08.txt

@@ -0,0 +1 @@
+зеаббгдеж

sourcedata/13/3/_data_small__play_16_45__06_08.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s122723176--2a0154f71791e9ea0bb09f3333d9f1b2

sourcedata/13/3/answers_small_16_45__06_08.txt

@@ -0,0 +1 @@
+заабвгдед

sourcedata/14/1/_data_large__play_15_43__15_08.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s123208080--d6bd235dd963b5a7e18616353a1163d7

sourcedata/14/1/answers_large_15_43__15_08.txt

@@ -0,0 +1 @@
+зжзбгвззе

sourcedata/14/4/_data_small__play_16_32__15_08.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s125741184--44786badb18f583e87b9268672833717

sourcedata/14/4/answers_small_16_32__15_08.txt

@@ -0,0 +1 @@
+жагагггеб

sourcedata/15/1/_data_large__play_18_58__15_08.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s127824272--4c876c6b5bf5e5c7ef7cfa3c7446d991

sourcedata/15/1/answers_large_18_58__15_08.txt

@@ -0,0 +1 @@
+здабвгдеж

sourcedata/15/3/_data_small__play_19_22__15_08.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s122421336--ad46f9fcc287c466d70a3843fae6ff00

sourcedata/15/3/answers_small_19_22__15_08.txt

@@ -0,0 +1 @@
+зжабвгдеж

sourcedata/16/2/_data_large__play_17_05__17_09.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s123097144--abe60eecbab607fc1e094cc0c7b78553

sourcedata/16/2/answers_large_17_05__17_09.txt

@@ -0,0 +1 @@
+зжзбвддбж

sourcedata/16/3/_data_small__play_17_19__17_09.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s122326080--9a1ff1f4a26e84f2d9e17cd51e599183

sourcedata/16/3/answers_small_17_19__17_09.txt

@@ -0,0 +1 @@
+зеабегдве

sourcedata/17/1/_data_large__play_14_32__19_11.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s125763920--2cab628868d35ba20864c65f8d9153e2

sourcedata/17/1/answers_large_14_32__19_11.txt

@@ -0,0 +1 @@
+441741221

sourcedata/17/3/_data_small__play_15_03__19_11.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s123971304--b93aad8a80732dc292602d3e3a38f41c

sourcedata/17/3/answers_small_15_03__19_11.txt

@@ -0,0 +1 @@
+277412362

sourcedata/18/1/_data_large__play_15_58__23_11.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s126269600--d8834529a395a1f93c60038a673a2725

sourcedata/18/1/answers_large_15_58__23_11.txt

@@ -0,0 +1 @@
+241631567

sourcedata/18/3/_data_small__play_16_32__23_11.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s128623952--0a5288447458f2596ef1b569b7fb5370

sourcedata/18/3/answers_small_16_32__23_11.txt

@@ -0,0 +1 @@
+173334562

sourcedata/19/1/_data_small__play_17_42__26_11.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s124809400--91b2504992af1e3bc36a1fd8248dc3b6

sourcedata/19/1/answers_small_17_42__26_11.txt

@@ -0,0 +1 @@
+274734361

sourcedata/19/3/_data_large__play_18_15__26_11.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s128335832--b980038a799554c3cd69dff38205dbe7

sourcedata/19/3/answers_large_18_15__26_11.txt

@@ -0,0 +1 @@
+615183237

sourcedata/20/1/_data_large__play_13_58__29_11.npy

@@ -0,0 +1 @@
+/annex/objects/MD5-s123883496--a9bf81c56b78cfef50d0c835fda16442