Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Alternative proposal to BEP038 #1856

Open
wants to merge 48 commits into
base: bep038
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
4fa15e5
first iteration of the alternative proposal
oesteban Jun 12, 2024
0180e3b
STY: codespell
effigies Jun 12, 2024
bba4159
Replace links to the schema with links to the glossary
effigies Jun 12, 2024
f159e61
enh: generalization of atlas metadata cc/ @jdkent
oesteban Jun 17, 2024
9390602
enh: address some of @effigies' comments
oesteban Jun 17, 2024
3f8c210
enh: reference entities from glossary
oesteban Jun 17, 2024
927335c
fix: folder => directory
oesteban Jun 17, 2024
6a3dcc7
fix: resolving issues with/within entities
oesteban Jun 17, 2024
f7e906d
enh: add mention to transforms files cc/ @peerherholz
oesteban Jun 17, 2024
57160cd
fix: revise more glossary links
oesteban Jun 17, 2024
1db3fd4
enh: move all filetree examples to macros
oesteban Jun 17, 2024
48e77ae
enh: miscellaneous improvements (sort entries in examples, etc.)
oesteban Jun 17, 2024
d6cf6a4
enh: improve intro
oesteban Jun 18, 2024
8bfc7ac
enh: add datatype comment to make it recommended cc/ @effigies
oesteban Jun 18, 2024
f2be20a
enh: start drafting cohort
oesteban Jun 18, 2024
d15677a
enh: add multi-cohort example
oesteban Jun 18, 2024
b275ca3
fix: pacify pre-commit build
oesteban Jun 18, 2024
f9ff346
enh: add the PS13 example
oesteban Jun 18, 2024
f0e8e0e
test
jdkent Jun 21, 2024
b00bdf8
Update src/derivatives/atlas.md
jdkent Jun 21, 2024
abe37b4
Update src/derivatives/atlas.md
jdkent Jun 21, 2024
d812b08
incorporate meeting feedback in schema
jdkent Jun 21, 2024
3accb28
enh: add note about 'MNI Space' below template identifiers @CPernet
oesteban Oct 7, 2024
e5e27f1
enh: clarify the creation of BOTH a new template AND atlas
oesteban Oct 7, 2024
8ffda51
fix: avoid using an atlas name for a segmentation label
oesteban Oct 7, 2024
d62f0d9
enh: rework the text to clarify notions: atlas, template, space
oesteban Oct 7, 2024
161db11
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 7, 2024
44cb808
fix: addressing some inconsistencies about segmentations
oesteban Oct 11, 2024
c77df10
fix: add clarification about cohort
oesteban Oct 11, 2024
947f279
fix: replace ``_mimap`` with ``_pet``
oesteban Oct 11, 2024
a5111aa
fix: replace ``label-`` with ``seg-`` where applies
oesteban Oct 12, 2024
c05146c
enh: update schema according to this proposal
oesteban Oct 12, 2024
f221ad0
fix: folder -> directory (pacify pre-commit)
oesteban Oct 12, 2024
9ec94cd
fix: order of ``scale-`` in the schema
oesteban Oct 12, 2024
1a258b5
enh: refine atlas' definition in common principles
oesteban Oct 12, 2024
79f1ea9
enh: add "authoritative definition of spaces" to template
oesteban Oct 12, 2024
3f2bde5
enh: update schema to consider ``tpl-`` and ``cohort-``
oesteban Oct 12, 2024
95a85a1
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 12, 2024
0d7f965
enh(schema): add ``atlas`` to entities
oesteban Oct 12, 2024
a9fa24a
fix: delete photo from atlas' file rules
oesteban Oct 12, 2024
44c3ad8
Update src/schema/objects/columns.yaml
oesteban Oct 12, 2024
b66c3ee
fix: dereference twice schema files
oesteban Oct 14, 2024
c3b6f41
fix: add missing properties to atlas entity definition
oesteban Oct 14, 2024
891bcf0
FIX: update PET examples
mnoergaard Oct 23, 2024
ef1817b
Merge remote-tracking branch 'upstream/bep038' into bep038-review
effigies Nov 5, 2024
bc6b064
schema: Move templates out of rules.files
effigies Nov 5, 2024
226f134
test: Fix check to avoid overlap between common_principles and common
effigies Nov 5, 2024
ac745e6
schema: Update metaschema, fix errors caught by metaschema
effigies Nov 5, 2024
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
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ nav:
- BIDS Derivatives: derivatives/introduction.md
- Common data types and metadata: derivatives/common-data-types.md
- Imaging data types: derivatives/imaging.md
- Templates and atlases: derivatives/atlas.md
- Longitudinal and multi-site studies: longitudinal-and-multi-site-studies.md
- Atlases: atlas.md
- Glossary: glossary.md
- BIDS Extension Proposals: extensions.md
- Appendix:
Expand Down
672 changes: 0 additions & 672 deletions src/atlas.md

This file was deleted.

34 changes: 31 additions & 3 deletions src/common-principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,12 @@ data type as defined above.
A data type directory SHOULD NOT be defined if there are no files to be placed
in that directory.

**Specific structure of derived data**.
In the case of [storing derived data (see below)](#source-vs-raw-vs-derived-data),
the subject (`sub-<label>`) and session (`ses-<label>`) entities MAY map onto
the template (`tpl-<label>`) and cohort (`cohort-<label>`) entities
as described in the [corresponding section](derivatives/atlas.md) of this specification.

### Other top level directories

In addition to the subject directories, the root directory of a BIDS dataset
Expand Down Expand Up @@ -305,6 +311,16 @@ field in `dataset_description.json` of each subdirectory of `derivatives` to:
}
```

**Templates and atlases as derived data.**
Templates and atlases are key neuroscientific tools to carry out group-level inferences
and also employed in many atlas-based methodologies (such as atlas-based segmentation).
Original templates and atlases employed as primary data to the analysis MAY be stored
within the `sourcedata/atlases/`.
Any artifacts deriving from atlases, or the creation of new templates and atlases MUST
follow the [corresponding specification](derivatives/atlas.md) and stored under the
`derivatives/` directory, and follow the general specifications for derivatives regarding
storage and distribution, as described in the next section.

### Storage of derived datasets

Derivatives can be stored/distributed in two ways:
Expand Down Expand Up @@ -340,6 +356,15 @@ Derivatives can be stored/distributed in two ways:
<dataset>/derivatives/spm-stats/sub-0001
```

Example of an atlas-generating pipeline with outputs for individual subjects
and the aggregation in an atlas defined with respect to the widely-used
[`MNI152NLin2009cAsym` standard space](appendices/coordinate-systems.md):

```Plain
<dataset>/derivatives/atlas-generator/sub-0001
<dataset>/derivatives/atlas-generator/tpl-MNI152NLin2009cAsym
```

Example of a pipeline with nested derivative directories:

```Plain
Expand Down Expand Up @@ -391,11 +416,14 @@ Case 2.
In both cases, every derivatives dataset is considered a BIDS dataset and must
include a `dataset_description.json` file at the root level (see
[Dataset description][dataset-description]).
Consequently, files should be organized to comply with BIDS to the full extent
Consequently, files SHOULD be organized to comply with BIDS to the full extent
possible (that is, unless explicitly contradicted for derivatives).
Any subject-specific derivatives should be housed within each subject's directory;
if session-specific derivatives are generated, they should be deposited under a
Any subject-specific derivatives SHOULD be housed within each subject's directory;
if session-specific derivatives are generated, they SHOULD be deposited under a
session subdirectory within the corresponding subject directory; and so on.
Likewise, any template-specific derivatives SHOULD be housed within each template's directory;
if cohort-specific derivatives are generated, they SHOULD be deposited under a
cohort subdirectory within the corresponding template directory; and so on.

### Non-compliant derivatives

Expand Down
Loading