Skip to content

Commit 8acb181

Browse files
authored
Merge pull request #39 from BioMedicalImaging-Core-NYUAD/kidlang_pipeline
Kidlang pipeline
2 parents 359e563 + a4cb386 commit 8acb181

File tree

162 files changed

+5996
-2625
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

162 files changed

+5996
-2625
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Box Dataset Info
2+
3+
on:
4+
workflow_dispatch:
5+
inputs:
6+
dataset_name:
7+
description: "Name of the dataset to inspect (leave empty to list all)"
8+
required: false
9+
default: ""
10+
11+
jobs:
12+
box-info:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Check out repository
16+
uses: actions/checkout@v4
17+
18+
- name: Set up Python
19+
uses: actions/setup-python@v5
20+
with:
21+
python-version: "3.11"
22+
23+
- name: Install dependencies
24+
run: |
25+
python -m pip install --upgrade pip
26+
pip install "boxsdk[jwt]"
27+
28+
- name: Run Box Info Script
29+
env:
30+
BOX_CLIENT_SDK_CONFIG: ${{ secrets.BOX_CLIENT_SDK_CONFIG }}
31+
BOX_FOLDER_ID: ${{ secrets.BOX_MEG_DATA_PARENT_FOLDER_ID }}
32+
run: |
33+
python pipeline/box_info/get_box_dataset_info.py \
34+
--box-folder-id "$BOX_FOLDER_ID" \
35+
--dataset-name "${{ github.event.inputs.dataset_name }}"

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ MANIFEST
5555
pip-log.txt
5656
pip-delete-this-directory.txt
5757

58+
render_log_*.txt
59+
.quarto
60+
_output
5861
# Unit test / coverage reports
5962
htmlcov/
6063
.tox/

.vscode/launch.json

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
{
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
"version": "0.2.0",
6+
"configurations": [
7+
{
8+
"name": "KIT Sanity Check Single Channel",
9+
"type": "debugpy",
10+
"request": "launch",
11+
"program": "${workspaceFolder}/pipeline/mne_pipelines/kit_general_pipelines/1-kit_count_sanity_check_single_channel.py",
12+
"console": "integratedTerminal",
13+
"args": [
14+
"-c",
15+
"${workspaceFolder}/pipeline/mne_pipelines/kit_general_pipelines/pipeline_config_files/config_template.yml"
16+
],
17+
"env": {
18+
"PYTHONPATH": "${workspaceFolder}"
19+
}
20+
},
21+
{
22+
"name": "CON to FIF",
23+
"type": "debugpy",
24+
"request": "launch",
25+
"program": "${workspaceFolder}/pipeline/mne_pipelines/kit_general_pipelines/2-kit_con_to_fif.py",
26+
"console": "integratedTerminal",
27+
"args": [
28+
"-c",
29+
"${workspaceFolder}/pipeline/mne_pipelines/kit_general_pipelines/pipeline_config_files/config_template.yml"
30+
],
31+
"env": {
32+
"PYTHONPATH": "${workspaceFolder}"
33+
}
34+
},
35+
{
36+
"name": "PLOT coreg sensor-laserhead",
37+
"type": "debugpy",
38+
"request": "launch",
39+
"program": "${workspaceFolder}/pipeline/mne_pipelines/kit_general_pipelines/3-kit_fif_plot_headshape_sensor_alignment.py",
40+
"console": "integratedTerminal",
41+
"args": [
42+
"-c",
43+
"${workspaceFolder}/pipeline/mne_pipelines/kit_general_pipelines/pipeline_config_files/config_template.yml"
44+
],
45+
"env": {
46+
"PYTHONPATH": "${workspaceFolder}"
47+
}
48+
},
49+
{
50+
"name": "Apply filters",
51+
"type": "debugpy",
52+
"request": "launch",
53+
"program": "${workspaceFolder}/pipeline/mne_pipelines/kit_general_pipelines/4-kit_apply_filters.py",
54+
"console": "integratedTerminal",
55+
"args": [
56+
"-c",
57+
"${workspaceFolder}/pipeline/mne_pipelines/kit_general_pipelines/pipeline_config_files/config_template.yml"
58+
],
59+
"env": {
60+
"PYTHONPATH": "${workspaceFolder}"
61+
}
62+
},
63+
{
64+
"name": "Compute events single channel",
65+
"type": "debugpy",
66+
"request": "launch",
67+
"program": "${workspaceFolder}/pipeline/mne_pipelines/kit_general_pipelines/5-kit_compute_events_single_channel.py",
68+
"console": "integratedTerminal",
69+
"args": [
70+
"-c",
71+
"${workspaceFolder}/pipeline/mne_pipelines/kit_general_pipelines/pipeline_config_files/config_template.yml"
72+
],
73+
"env": {
74+
"PYTHONPATH": "${workspaceFolder}"
75+
}
76+
},
77+
{
78+
"name": "Compute evoked response",
79+
"type": "debugpy",
80+
"request": "launch",
81+
"program": "${workspaceFolder}/pipeline/mne_pipelines/kit_general_pipelines/6-kit_evoked_response_single_channel.py",
82+
"console": "integratedTerminal",
83+
"args": [
84+
"-c",
85+
"${workspaceFolder}/pipeline/mne_pipelines/kit_general_pipelines/pipeline_config_files/config_template.yml"
86+
],
87+
"env": {
88+
"PYTHONPATH": "${workspaceFolder}"
89+
}
90+
}
91+
]
92+
}

.vscode/settings.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"python.envFile": "${workspaceFolder}/.env",
3+
"git.requireCommitMessage": true
4+
}

docs/source/2-meg-kit-system/6-experiment-design.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,21 @@ Depending on the number of different event types that you require for your exper
6565

6666

6767

68+
Saving your event file
69+
----------------------
70+
71+
Your experiment should save a tabular event file (.csv or .tsv) with the following columns:
72+
73+
- `onset`: the onset time of the event in seconds (do not fill this column from your experiment code, it will be filled later when pre-processing your data)
74+
- `duration`: the duration of the event in seconds (if relevant for the research question, if not leave blank)
75+
- `trial_type`: the trial type defined as a string symbolising the type of trial (no need to be very detailed: example: cat, dog, afraid, fruit, emotion etc...). This information is used to average trials with the same type together.
76+
77+
Additionally,
78+
- if you are using TriggerMode: `single_channel` then add the following column:
79+
- `channel`: the channel on which the trigger is sent
80+
- if you are using TriggerMode: `binary_coded` then add the following column:
81+
- `binary_code`: the binary code associated to the event type
82+
6883
Files produced by the experiment design
6984
---------------------------------------
7085

docs/source/4-meg-experiments-gallery/1-meg-experiments.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,13 @@ Psychopy
3535
experiments/psychopy/*
3636

3737

38+
Presentation
39+
^^^^^^^^^^^^
40+
41+
.. nbgallery::
42+
:glob:
43+
44+
experiments/presentation/*
45+
46+
3847

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Experiment example: Kidlang
2+
---------------------------
3+
4+
Author: Sherine Bou Dergham
5+
6+
Description
7+
^^^^^^^^^^^
8+
9+
In this experiment implemented using the `Presentation` framework
10+
11+
-
12+
13+
Stimulus Code access
14+
^^^^^^^^^^^^^^^^^^^^
15+
16+
Available upon request
17+
18+
Data access
19+
^^^^^^^^^^^
20+
21+
Acquired datasets are stored safely on NYU Box under `kidlang`.
22+
23+
`MEG Data Directory <https://nyu.box.com/v/meg-datafiles>`_
24+
25+
Analysis results
26+
^^^^^^^^^^^^^^^^
27+
28+
NA
29+

docs/source/4-meg-experiments-gallery/experiments/psychtoolbox/auditory-vs-visual.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ Every stimulis occurrence is spaced from the next one by an Inter-Stimulus Inte
2828

2929

3030

31-
Code access
32-
^^^^^^^^^^^
31+
Stimulus Code access
32+
^^^^^^^^^^^^^^^^^^^^
3333

3434
:github-file:`Auditory vs Visual vs Motor Experiment Code <experiments/psychtoolbox/auditory-vs-visual>`
3535

docs/source/4-meg-experiments-gallery/experiments/psychtoolbox/resting-state.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ In MNE reference:
2020
- Channel 225 in KIT indexing corresponds to `MISC 002`
2121

2222

23-
Code access
24-
^^^^^^^^^^^
23+
Stimulus Code access
24+
^^^^^^^^^^^^^^^^^^^^
2525

2626
:github-file:`Resting State Eyes Closed <experiments/psychtoolbox/restingstate/resting_state_meg_EYES_CLOSED.m>`
2727

docs/source/4-meg-experiments-gallery/experiments/psychtoolbox/visual-crowd-preview.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ The .mat file outputs a table with relevant information about the trials, such a
6161

6262

6363

64-
Code access
65-
^^^^^^^^^^^
64+
Stimulus Code access
65+
^^^^^^^^^^^^^^^^^^^^
6666

6767
:github-file:`Visual Crowd Preview <experiments/psychtoolbox/visual_crowding_preview>`
6868

0 commit comments

Comments
 (0)