diff --git a/README.md b/README.md index d475593..394e9c3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,86 @@ -# Neuroscience Data Structure (NDS) +\# Neuroscience Data Structure (NDS) Examples -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] + +\## 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": { + +  "id": "sub-002", + +  "species": "Rattus norvegicus", + +  "age": 20, + +  "sex": "M" + +  }, + +  "session": { + +  "id": "ses-001", + +  "task": "maze\_navigation", + +  "acquisition": { + +  "device": "VideoTracking", + +  "frame\_rate": 30 + +  } + +  } + +} +