Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 .`

Expand Down
2 changes: 1 addition & 1 deletion dataset_description.json
Original file line number Diff line number Diff line change
@@ -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)",
Expand Down
5 changes: 5 additions & 0 deletions rawbids/README.md
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 5 additions & 1 deletion sourcedata/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!).

....