add some comments

Author: Remi-Gau

README.md

@@ -101,23 +101,31 @@ Here are the naming templates used.
 
 -   Behavior
 
-`sub-<label>[_ses-<label>]_task-<label>[_acq-<label>][_run-<index>]_events.tsv`
-`sub-<label>[_ses-<label>]_task-<label>[_acq-<label>][_run-<index>]_events.json`
-`sub-<label>[_ses-<label>]_task-<label>[_acq-<label>][_run-<index>]_beh.tsv`
-`sub-<label>[_ses-<label>]_task-<label>[_acq-<label>][_run-<index>]_beh.json`
+```
+sub-<label>[_ses-<label>]_task-<label>[_acq-<label>][_run-<index>]_events.tsv
+sub-<label>[_ses-<label>]_task-<label>[_acq-<label>][_run-<index>]_events.json
+sub-<label>[_ses-<label>]_task-<label>[_acq-<label>][_run-<index>]_beh.tsv
+sub-<label>[_ses-<label>]_task-<label>[_acq-<label>][_run-<index>]_beh.json
+```
 
 -   BOLD
 
-`sub-<label>[_ses-<label>]_task-<label>[_acq-<label>][_ce-<label>][_dir-<label>][_rec-<label>][_run-<index>][_echo-<index>]_<contrast_label>.nii[.gz]`
+```
+sub-<label>[_ses-<label>]_task-<label>[_acq-<label>][_ce-<label>][_dir-<label>][_rec-<label>][_run-<index>][_echo-<index>]_<contrast_label>.nii[.gz]
+```
 
 -   iEEG
 
-`sub-<label>[_ses-<label>]_task-<task_label>[_run-<index>]_ieeg.json`
+```
+sub-<label>[_ses-<label>]_task-<task_label>[_run-<index>]_ieeg.json
+```
 
 -   EEG
 
-`sub-<label>[_ses-<label>]_task-<label>[_run-<index>]_eeg.<manufacturer_specific_extension>`
-`sub-<label>[_ses-<label>]_task-<label>[_run-<index>]_eeg.json`
+```
+sub-<label>[_ses-<label>]_task-<label>[_run-<index>]_eeg.<manufacturer_specific_extension>
+sub-<label>[_ses-<label>]_task-<label>[_run-<index>]_eeg.json
+```
 
 <!-- European data format (Each recording consisting of a .edf file)
 
@@ -136,14 +144,19 @@ Biosemi data format (Each recording consisting of a .bdf file) -->
 current format `<matches>_recording-eyetracking_physio.tsv.gz`
 
 future BEP format in a dedicated eyetracker folder
-`sub-<participant_label>[_ses-<label>][_acq-<label>]_task-<task_label>_eyetrack.<manufacturer_specific_extension>`
+
+```
+sub-<participant_label>[_ses-<label>][_acq-<label>]_task-<task_label>_eyetrack.<manufacturer_specific_extension>
+```
 
 -   Stim and physio
 
-`<matches>[_recording-<label>]_physio.tsv.gz`
-`<matches>[_recording-<label>]_physio.json`
-`<matches>[_recording-<label>]_stim.tsv.gz`
-`<matches>[_recording-<label>]_stim.json`
+```
+<matches>[_recording-<label>]_physio.tsv.gz
+<matches>[_recording-<label>]_physio.json
+<matches>[_recording-<label>]_stim.tsv.gz
+<matches>[_recording-<label>]_stim.json
+```
 
 ### Change log
 

notebooks/using_2_logfiles.ipynb

@@ -4,12 +4,15 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# saving two `_events.tsv` for the same run"
+    "# saving two `_events.tsv` for the same run\n",
+    "\n",
+    "This won't create BIDS valid output but this might help you organize some of your output in different TSV files.\n",
+    "\n"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 32,
+   "execution_count": 1,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -23,7 +26,7 @@
     "cfg.subject.subjectNb = 1;\n",
     "cfg.subject.runNb = 1;\n",
     "\n",
-    "cfg.testingDevice = 'mri';\n",
+    "cfg.testingDevice = 'pc';\n",
     "\n",
     "cfg.verbose = true;"
    ]
@@ -37,7 +40,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 33,
+   "execution_count": 2,
    "metadata": {
     "scrolled": true
    },
@@ -48,10 +51,10 @@
      "text": [
       "\r\n",
       "Data will be saved in this directory:\r\n",
-      "\t/home/remi/github/CPP_BIDS/notebooks/output/source/sub-001/ses-001/func\r\n",
+      "\t/home/remi/github/CPP_BIDS/notebooks/output/source/sub-001/ses-001/beh\r\n",
       "\r\n",
       "Data will be saved in this file:\r\n",
-      "\tsub-001_ses-001_task-testTask_run-001_events_date-202010191333.tsv\r\n"
+      "\tsub-001_ses-001_task-testTask_run-001_events_date-202010191603.tsv\r\n"
      ]
     }
    ],
@@ -62,7 +65,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 34,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [
     {
@@ -86,7 +89,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 35,
+   "execution_count": 4,
    "metadata": {},
    "outputs": [
     {
@@ -95,10 +98,10 @@
      "text": [
       "\r\n",
       "Data will be saved in this directory:\r\n",
-      "\t/home/remi/github/CPP_BIDS/notebooks/output/source/sub-001/ses-001/func\r\n",
+      "\t/home/remi/github/CPP_BIDS/notebooks/output/source/sub-001/ses-001/beh\r\n",
       "\r\n",
       "Data will be saved in this file:\r\n",
-      "\tsub-001_ses-001_task-testTask_acq-extraInfo_run-001_events_date-202010191333.tsv\r\n"
+      "\tsub-001_ses-001_task-testTask_acq-extraInfo_run-001_events_date-202010191603.tsv\r\n"
      ]
     }
    ],
@@ -113,7 +116,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 36,
+   "execution_count": 5,
    "metadata": {},
    "outputs": [
     {
@@ -138,8 +141,10 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 37,
-   "metadata": {},
+   "execution_count": 6,
+   "metadata": {
+    "scrolled": true
+   },
    "outputs": [
     {
      "name": "stdout",
@@ -188,6 +193,33 @@
     "\n",
     "logFile_2 = saveEventsFile('save', cfg, logFile_2);"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "Data were saved in this file:\n",
+      "\n",
+      "/home/remi/github/CPP_BIDS/notebooks/output/source/sub-001/ses-001/beh/sub-001_ses-001_task-testTask_run-001_events_date-202010191603.tsv\n",
+      "\n",
+      "\n",
+      "Data were saved in this file:\n",
+      "\n",
+      "/home/remi/github/CPP_BIDS/notebooks/output/source/sub-001/ses-001/beh/sub-001_ses-001_task-testTask_acq-extraInfo_run-001_events_date-202010191603.tsv\n",
+      "\n"
+     ]
+    }
+   ],
+   "source": [
+    "saveEventsFile('close', cfg, logFile);\n",
+    "saveEventsFile('close', cfg, logFile_2);"
+   ]
   }
  ],
  "metadata": {