From a67f606ebf006d435341686c36ad247f1f311462 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Thu, 30 Jul 2026 14:13:11 -0400 Subject: [PATCH 1/2] Prepare for rawbids/ to be released in coming BIDS, and elaborate on sourcedata/ - Closes #2 --- README.md | 6 +++--- dataset_description.json | 2 +- sourcedata/README.md | 6 +++++- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c094d86..2f289d0 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,13 @@ specification](https://bids-specification.readthedocs.io/en/stable/common-princi Overall checklist to "check out" and potentially populate (if points to a folder). Each folder should contain `README.md` with further details orienting user in its content +- [ ] [`code/`](./code) - code for managing the project data ingest under `code/` subfolder +- [ ] [`derivatives/`](./derivatives) - TODO... - [ ] [`docs/`](./docs) - documentation for the study (original paper, +- [ ] [`rawbids/`](./rawbids) - if preparing BIDS "raw" dataset, place it there ideally as a separate research plan from gran proposal, slides, etc) to be placed under - [ ] [`sourcedata/`](./sourcedata) - your "source data" (before NWB/BIDS-ification) in subfolders under `sourcedata/` -- [ ] `sourcedata/raw/` - if preparing BIDS "raw" dataset, place it there ideally as a separate "BIDS raw" dataset formatted most appropriate for your study. -- [ ] [`derivatives/`](./derivatives) - TODO... -- [ ] [`code/`](./code) - code for managing the project data ingest under `code/` subfolder - [ ] [`logs/`](./logs) - log files - [ ] this dataset should pass validation using BIDS validator, e.g. via `uvx bids-validator-deno .` diff --git a/dataset_description.json b/dataset_description.json index a52516e..c0c04f2 100644 --- a/dataset_description.json +++ b/dataset_description.json @@ -1,6 +1,6 @@ { "Name": "EMBER Project TODO-FILL short name summarizing the study", - "BIDSVersion": "1.10.1", + "BIDSVersion": "1.11.2", "DatasetType": "study", "Description": "TODO-FILL long(er) description, in a single long paragraph", "License": "Apache 2.0 (subdatasets could have their own)", diff --git a/sourcedata/README.md b/sourcedata/README.md index 696a1a3..32b6791 100644 --- a/sourcedata/README.md +++ b/sourcedata/README.md @@ -3,6 +3,10 @@ TODO-FILL along the lines: This folder contains - all source data for the project, in original, potentially proprietary and non-standard forms. -- BIDS raw dataset under `raw/` folder + +Some or all of the materials in this folder could be used to form the BIDS raw dataset under `../rawbids/` folder. + +For that, later, to satisfy the [STAMPED principle](https://stamped-principles.org/) of [Self-containment](https://examples.stamped-principles.org/stamped_principles/s/), they might be copied or otherwise efficiently linked (e.g. `git submodule` AKA ["DataLad subdataset"](https://handbook.datalad.org/en/latest/basics/101-106-nesting.html) mechanism) under `../rawbids/sourcedata/`. +So, in principle, `sourcedata/` could altogether be a "git submodule" with all sourcedata used in both places (potentially of a different version!). .... From 5679af140df3dc86b767ac94b435c0a3ca030c3b Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Mon, 3 Aug 2026 13:37:52 -0400 Subject: [PATCH 2/2] Add placeholder README.md for the rawbids/ --- rawbids/README.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 rawbids/README.md diff --git a/rawbids/README.md b/rawbids/README.md new file mode 100644 index 0000000..1c18699 --- /dev/null +++ b/rawbids/README.md @@ -0,0 +1,5 @@ +## `rawbids` instructions + +This nested BIDS "raw" dataset will likely to be produced fully or partially +using some of the "BIDS converters" you can find listed at +https://bids.neuroimaging.io/tools/converters.html , thus replacing this README.md as well.