Skip to content

Commit 587d57e

Browse files
julia-pfarroestebaneffigies
authored
[ENH] BEP020 examples (#514)
* enh: add first dataset (ds004158) Complements: bids-standard/bids-specification#1128. * enh: add second dataset (natImSac) Complements: bids-standard/bids-specification#1128 * enh: leave only two participants per example * fix: point schema to BEP020's version * modify examples according to new BEP020 updates * resolve validator issues * fix participants.tsv * chore: Skip eyetracking on older validators * Fix JSON schema complaints * Fix JSON schema complaints * Add gzip headers to tsv.gz files * chore(ci): Install BEP020 branch of validator * add missing ScreenOrigin * change openneuro reference * Apply suggestions from code review Co-authored-by: Chris Markiewicz <effigies@gmail.com> * correct screen distance and delete EnvironmentCoordinates * Revert to using the dev version of the validator * change StartTime and delete StopTime * fix StartTime * Update .github/workflows/validate_datasets.yml --------- Co-authored-by: Oscar Esteban <code@oscaresteban.es> Co-authored-by: Christopher J. Markiewicz <markiewicz@stanford.edu> Co-authored-by: Chris Markiewicz <effigies@gmail.com>
1 parent d7ba6ec commit 587d57e

File tree

52 files changed

+801
-1
lines changed

Some content is hidden

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

52 files changed

+801
-1
lines changed

‎.github/workflows/validate_datasets.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ jobs:
148148
- name: Skip main validation for datasets with unreleased spec features
149149
# Replace ${EMPTY} with dataset patterns, when this is needed
150150
# Reset to "for DS in ${EMPTY}; ..." after a spec release
151-
run: for DS in atlas-* emg_*; do touch $DS/.SKIP_VALIDATION; done
151+
run: for DS in eyetracking_* atlas-* emg_*; do touch $DS/.SKIP_VALIDATION; done
152152
if: matrix.bids-validator != 'dev'
153153

154154
- name: Set BIDS_SCHEMA variable for dev version

‎eyetracking_binocular/README.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Example BIDS Physio-EyeTracking Dataset - Binocular Recordings
2+
3+
## Data descriptor
4+
5+
Authors: Martin SZINTE, Guillaume Masson, Jason Samonds & Nicholas Priebe
6+
BIDS-Conversion: Julia-Katharina Pfarr, Rémi Gau
7+
BIDS-Example: Julia-Katharina Pfarr, Oscar Esteban
8+
Project: natImSac
9+
Version: 1.0
10+
11+
## Data
12+
13+
This example corresponds to the structure of the "natImSac" project, adapted to demonstrate BEP020.
14+
This example does not contain any eye-tracking data, it just shows the BIDS organization of an experiment with an eye-tracker.
15+
For the full example preserving the actual eye-tracker recordings, please access the DataLad dataset at https://github.com/julia-pfarr/natImSac_BIDSexample.git.
16+
17+
The original source data is found at https://github.com/mszinte/natImSac.
18+
The natImSac involved an experiment in which human participant free view natural images to determine saccade and fixation statistics.
19+
Full description of the project is found in the following [publication](https://doi.org/10.1523/ENEURO.0287-23.2023).
20+
Only the eye-tracking data of the original dataset and a subset of participants and runs thereof were kept for this example dataset.
21+
22+
## Methods (BIDS Conversion)
23+
24+
Sourcedata was converted to raw data according to the BIDS Physio-EyeTracking specification using the [eye2bids](https://github.com/bids-standard/eye2bids) converter tool.

‎eyetracking_binocular/dataset_description.json‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"Name": "natImSac",
3+
"BIDSVersion": "1.10.0-dev",
4+
"DatasetType": "raw",
5+
"License": "CCBY4",
6+
"Authors": [
7+
"Martin Szinte",
8+
"Guillaume Masson",
9+
"Jason Samonds",
10+
"Nicholas Priebe"
11+
],
12+
"HowToAcknowledge": "Please cite this paper: https://doi.org/10.1523/ENEURO.0287-23.2023",
13+
"Funding": [
14+
"This research was funded by Agence Nationale de la Recherche ANR-20NEUC-0002 (G.S.M.) and National Institutes of Health NIH-R01NS120562 (N.J.P.), NIH-R01EY025102 (N.J.P.), and NIH-R01EY034092 (J.M.S.)."
15+
],
16+
"GeneratedBy": [
17+
{
18+
"Name": "eye2bids",
19+
"CodeURL": "https://github.com/bids-standard/eye2bids"
20+
}
21+
],
22+
"SourceDatasets": [
23+
{
24+
"URL": "https://github.com/mszinte/natImSac",
25+
"Version": "October 2020"
26+
}
27+
]
28+
}

‎eyetracking_binocular/participants.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"participant_id": {
3+
"LongName": "patient idnetification",
4+
"Description": "anonymized, BIDS compatible identification"
5+
}
6+
}

‎eyetracking_binocular/participants.tsv‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
participant_id
2+
sub-01

‎eyetracking_binocular/sub-01/beh/sub-01_task-FreeView_run-01_events.tsv‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
onset duration run_number trial_number image_blank_size image_blank_num
2+
1785.302201 32.0600146 1 1 2 77
3+
1817.506034 31.9947156 1 2 1 16
4+
1849.675358 32.0047486 1 3 1 50
5+
1881.846792 31.9950453 1 4 1 70
6+
1914.00865 32.0089389 1 5 1 33
7+
1946.145349 31.9961995 1 6 1 81
8+
1978.265709 31.9956032 1 7 2 57
9+
2010.394642 31.995466 1 8 2 26
10+
2042.549024 29.9995082 1 9 1 76

‎eyetracking_binocular/sub-01/beh/sub-01_task-FreeView_run-01_recording-eye1_physio.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"StartTime": 0,
3+
"CalibrationCount": 1,
4+
"CalibrationType": "HV13",
5+
"RecordedEye": "left",
6+
"AverageCalibrationError": 0.29,
7+
"MaximalCalibrationError": 0.61
8+
}

‎eyetracking_binocular/sub-01/beh/sub-01_task-FreeView_run-01_recording-eye1_physio.tsv.gz‎

20 Bytes
Binary file not shown.

‎eyetracking_binocular/sub-01/beh/sub-01_task-FreeView_run-01_recording-eye1_physioevents.tsv.gz‎

20 Bytes
Binary file not shown.

‎eyetracking_binocular/sub-01/beh/sub-01_task-FreeView_run-01_recording-eye2_physio.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"StartTime": 0,
3+
"CalibrationCount": 1,
4+
"CalibrationType": "HV13",
5+
"RecordedEye": "right",
6+
"AverageCalibrationError": 0.3,
7+
"MaximalCalibrationError": 0.65
8+
}

0 commit comments

Comments
 (0)