From 42b4d477c1438483e85bbc6e795fe64c047d95d8 Mon Sep 17 00:00:00 2001 From: SamihaAlii Date: Sat, 27 Sep 2025 19:24:13 +0530 Subject: [PATCH 1/3] docs: add usage examples to README for Neuroscience Data Structure --- README.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 60 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d475593..7ed1028 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,62 @@ -# Neuroscience Data Structure (NDS) +\# Neuroscience Data Structure (NDS) + + + +The objective of this project is to put together a set of specifications and tools that would allow the standardization of a directory structure containing experimental data recorded with animal models in neuroscience. + +For this, we aim at capitalizing on the success of BIDS for human neuroimaging data, while retaining the specificities of data sets obtained in animal models. + +Such a standardized data structure will facilitate obtaining reproducible research and data sharing following the FAIR principles. + +\[Note that the name Neuroscience Data Structure and the associated acronym NDS are purely provisional.] + + + +--- + + + +\## Examples + + + +Here’s a minimal example of how to organize subject and session data in NDS: + + + +```json + +{ + +  "subject": { + +  "id": "sub-001", + +  "species": "Mus musculus", + +  "age": 12, + +  "sex": "F" + +  }, + +  "session": { + +  "id": "ses-001", + +  "task": "visual\_stimulus", + +  "acquisition": { + +  "device": "EEG", + +  "channels": 64 + +  } + +  } + +} + -The objective of this project is to put together a set of specifications and tools that would allow the standardization of a directory structure containing experimental data recorded with animal models in neuroscience. -For this, we aim at capitalizing on the success of BIDS for human neuroimaging data, while retaining the specificities of data sets obtained in animal models. -Such a standardized data structure will facilitate obtaining reproducible research and data sharing following the FAIR principles. -[Note that the name Neuroscience Data Structure and the associated acronym NDS are purely provisonal] From eb4b81e7034424095f42fc96a683b3005823482c Mon Sep 17 00:00:00 2001 From: SamihaAlii Date: Sat, 27 Sep 2025 19:32:29 +0530 Subject: [PATCH 2/3] docs: improve human-readability of example datasets --- README.md | 42 +++++++----------------------------------- 1 file changed, 7 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 7ed1028..bde4038 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,14 @@ -\# Neuroscience Data Structure (NDS) - - - -The objective of this project is to put together a set of specifications and tools that would allow the standardization of a directory structure containing experimental data recorded with animal models in neuroscience. - -For this, we aim at capitalizing on the success of BIDS for human neuroimaging data, while retaining the specificities of data sets obtained in animal models. - -Such a standardized data structure will facilitate obtaining reproducible research and data sharing following the FAIR principles. - -\[Note that the name Neuroscience Data Structure and the associated acronym NDS are purely provisional.] - - - ---- - - - -\## Examples - - - -Here’s a minimal example of how to organize subject and session data in NDS: - - - -```json - {   "subject": { -  "id": "sub-001", +  "id": "sub-002", -  "species": "Mus musculus", +  "species": "Rattus norvegicus", -  "age": 12, +  "age": 20, -  "sex": "F" +  "sex": "M"   }, @@ -44,13 +16,13 @@ Here’s a minimal example of how to organize subject and session data in NDS:   "id": "ses-001", -  "task": "visual\_stimulus", +  "task": "maze\_navigation",   "acquisition": { -  "device": "EEG", +  "device": "VideoTracking", -  "channels": 64 +  "frame\_rate": 30 // Frames per second   } From e16ac65b4f18592d76936a075eae51af7f741d34 Mon Sep 17 00:00:00 2001 From: SamihaAlii Date: Sat, 27 Sep 2025 19:45:13 +0530 Subject: [PATCH 3/3] docs: add raw vs processed data example and JSON subject/session example --- README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 55 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bde4038..394e9c3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,57 @@ +\# Neuroscience Data Structure (NDS) Examples + + + +\## Raw vs Processed Data Example + + + +In NDS, experimental data is organized into `raw/` and `processed/` directories: + + + +project/ + +├── sub-001/ + +│ ├── ses-001/ + +│ │ ├── raw/ + +│ │ │ ├── eeg\_data.edf + +│ │ │ └── video.mp4 + +│ │ └── processed/ + +│ │ ├── eeg\_cleaned.fif + +│ │ └── motion\_tracking.csv + + + +yaml + +Copy code + + + +\- `raw/`: contains the \*\*original unprocessed data\*\*. + +\- `processed/`: contains \*\*cleaned or analyzed data\*\*, ready for sharing or further analysis. + + + +--- + + + +\## JSON Example for a Subject and Session + + + +```json + {   "subject": { @@ -22,7 +76,7 @@   "device": "VideoTracking", -  "frame\_rate": 30 // Frames per second +  "frame\_rate": 30   } @@ -30,5 +84,3 @@ } - -