Skip to content

Commit d615e66

Browse files
committed
fix: pacify codespell + links to entities (rather than glossary)
1 parent 045a4cb commit d615e66

File tree

2 files changed

+28
-25
lines changed

2 files changed

+28
-25
lines changed

src/derivatives/atlas.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,16 @@ or the integration of existing ones to define a stereotactic space.
2020

2121
For derivatives of template-generating pipelines, which typically aggregate
2222
several sessions and/or subjects, the derivatives-specific
23-
[`tpl-<label>` entity](../glossary.md#template-entities) indicates that the
23+
[`tpl-<label>` entity](../appendices/entities.md#tpl) indicates that the
2424
spatial frame of analysis is not defined by a single brain image but an
2525
aggregation thereof.
26-
On that sense, the [`tpl-<label>` entity](../glossary.md#template-entities)
27-
would be dual in terms of usage to BIDS raw's [`sub-<label>`](../glossary.md#subject-entities).
26+
On that sense, the [`tpl-<label>` entity](../appendices/entities.md#tpl)
27+
would be dual in terms of usage to BIDS raw's [`sub-<label>`](../appendices/entities.md#sub).
2828

2929
!!! tip "Recommendation"
3030

31-
The selected `<label>` in the [`tpl-<label>` entity](../glossary.md#template-entities)
32-
is RECOMMENDED for the [`space-<label>` entity](../appendices/entities.md#space-entities)
31+
The selected `<label>` in the [`tpl-<label>` entity](../appendices/entities.md#tpl)
32+
is RECOMMENDED for the [`space-<label>` entity](../appendices/entities.md#space)
3333
in downstream derivatives from this particular template (see previous section
3434
[Derivatives from atlases](imaging.md#derivatives-from-atlases)).
3535

@@ -51,17 +51,17 @@ such as `T1w` or `PET`; and
5151
Please note that the [`<datatype>/` directory](../glossary.md#data_type-common_principles) is RECOMMENDED.
5252
Like for the remainder of BIDS Derivatives,
5353
the [`<datatype>/` directory](../glossary.md#data_type-common_principles) MAY be omitted in the case
54-
only one data type (such as `anat/`) is stored under the `tpl-<label>` directory.
54+
only one data type (such as `anat/`) is stored under the `tpl-<label>/` directory.
5555

56-
The [`cohort-<label>` directory and entity](../glossary.md#cohort-entities) MUST be specified for templates
56+
The [`cohort-<label>` directory and entity](../appendices/entities.md#cohort) MUST be specified for templates
5757
with several cohorts.
58-
The [`cohort-<label>` directory and entity](../glossary.md#cohort-entities) are dual in terms of usage to BIDS raw's
59-
[`session-<label>`](../glossary.md#session-entities).
58+
The [`cohort-<label>` directory and entity](../appendices/entities.md#cohort) are dual in terms of usage to BIDS raw's
59+
[`session-<label>`](../appendices/entities.md#ses).
6060

6161
### Example: the `MNI152NLin2009cAsym` template
6262

63-
For the pipeline that generated the MNI152NLin2009cAsym, the outputs could look
64-
like the following example:
63+
For the pipeline that generated [`MNI152NLin2009cAsym`](../appendices/coordinate-systems.md#standard-template-identifiers),
64+
the outputs could look like the following example:
6565

6666
<!-- This block generates a file tree.
6767
A guide for using macros can be found at
@@ -99,7 +99,7 @@ A guide for using macros can be found at
9999

100100
In the case that the template-generating pipeline derives
101101
several cohorts, the file structure must employ the
102-
[`cohort-<label>` directory and entity](../glossary.md#cohort-entities).
102+
[`cohort-<label>` directory and entity](../appendices/entities.md#cohort).
103103

104104
<!-- This block generates a file tree.
105105
A guide for using macros can be found at
@@ -260,7 +260,7 @@ corresponding to the atlas or atlases in the structure.
260260
!!! tip "Recommendation"
261261

262262
The selected `<label>` in the `atlas-<label>_description.json` file is RECOMMENDED
263-
for the [`atlas-<label>` entity](../appendices/entities.md#atlas-entities)
263+
for the [`atlas-<label>` entity](../appendices/entities.md#atlas)
264264
in downstream derivatives from this particular atlas (see previous section
265265
[Derivatives from atlases](imaging.md#derivatives-from-atlases)).
266266

@@ -389,7 +389,7 @@ where `atlas-Dietrich2009_description.json` could contain:
389389

390390
Finally, in 2011 a second atlas was developed integrating new segmentations.
391391
Now, to disambiguate between the two atlases,
392-
the [`atlas-<label>` entity](../appendices/entities.md#atlas-entities) MUST be used:
392+
the [`atlas-<label>` entity](../appendices/entities.md#atlas) MUST be used:
393393

394394
<!-- This block generates a file tree.
395395
A guide for using macros can be found at
@@ -682,7 +682,8 @@ A guide for using macros can be found at
682682
**A more comprehensive example.**
683683
For example, the [PS13 atlas](https://doi.org/10.18112/openneuro.ds004401.v1.3.0),
684684
a molecular imaging brain atlas of Cyclooxygenase-1 (PET),
685-
was generated in two standard spaces: `MNI152Lin` and `fsaverage`:
685+
was generated in [two standard spaces](../appendices/coordinate-systems.md#standard-template-identifiers)
686+
(`MNI152Lin` and `fsaverage`):
686687

687688
<!-- This block generates a file tree.
688689
A guide for using macros can be found at
@@ -760,11 +761,12 @@ A guide for using macros can be found at
760761
}}
761762

762763
If the pipeline generates two different atlases for at least one template space
763-
in the output, then [`atlas-<label>`](../glossary.md#atlas-entities) is REQUIRED
764+
in the output, then [`atlas-<label>`](../appendices/entities.md#atlas) is REQUIRED
764765
for disambiguation.
765766
For example, let's imagine the PS13 atlas is revised in 2034, and based on the
766767
original pipeline and data, it generates now a new manual segmentation
767-
in the `MNI152Lin` space with some new regions defined.
768+
in the [`MNI152Lin` space](../appendices/coordinate-systems.md#standard-template-identifiers)
769+
with some new regions defined.
768770
The new atlas can be structured as follows:
769771

770772
<!-- This block generates a file tree.
@@ -808,10 +810,10 @@ A guide for using macros can be found at
808810
### Deriving an atlas in a study-specific template space and generating conversions to pre-existing template references
809811

810812
A usual scenario involves the generation of the atlas in a new, study-specific space
811-
and then provide resamplings of the template with reference to existing, widely used
812-
spaces such as MNI.
813+
and then provide resamplings of the template with reference to existing,
814+
[standard spaces](../appendices/coordinate-systems.md#standard-template-identifiers).
813815

814-
In this case, all atlas' derivatives MUST be stored within a single `tpl-<label>/` folder
816+
In this case, all atlas' derivatives MUST be stored within a single `tpl-<label>/` directory
815817
For example, if the previous PS13 example had been generated that way, the previous
816818
example would be updated as follows:
817819

@@ -891,7 +893,8 @@ A guide for using macros can be found at
891893
}}
892894

893895
where `tpl-ps13_desc-nopvc_pet.nii.gz` and `tpl-ps13_desc-pvc_pet.nii.gz` SHOULD NOT define
894-
a `space-<label>` and therefore MUST be defined in the space defined by `tpl-<label>`,
896+
a [`space-<label>`](../appendices/entities.md#space) and therefore
897+
MUST be defined in the space defined by [`tpl-<label>` entity](../appendices/entities.md#tpl),
895898
that is, the study-specific template.
896899
This example can be further extended to the example in which a revision of the atlas
897900
is done later in time:

src/derivatives/imaging.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -559,15 +559,15 @@ Template:
559559
<source_entities>[_space-<space>][_atlas-<label>][seg-<label>][_scale-<label>][_res-<label>][_den-<label>][_desc-<label>]_<suffix>.<extension>
560560
```
561561

562-
- [`space-<label>`](../glossary.md#space-entities) is REQUIRED to disambiguate derivatives defined with
562+
- [`space-<label>`](../appendices/entities.md#space) is REQUIRED to disambiguate derivatives defined with
563563
respect to different [coordinate systems](../appendices/coordinate-systems.md), following the general
564564
BIDS-Derivatives specifications.
565-
- [`atlas-<label>`](../glossary.md#atlas-entities) is REQUIRED to encode files pertaining
565+
- [`atlas-<label>`](../appendices/entities.md#atlas) is REQUIRED to encode files pertaining
566566
or derived from the atlas identified by the entity's label.
567-
- [`seg-<label>`](../glossary.md#segmentation-entities) is REQUIRED when a single atlas has several different
567+
- [`seg-<label>`](../appendices/entities.md#seg) is REQUIRED when a single atlas has several different
568568
realizations (for instance, segmentations and parcellations created with different criteria) that
569569
need disambiguation.
570-
- [`scale-<label>`](../glossary.md#scale-entities) is REQUIRED to disambiguate different atlas 'scales',
570+
- [`scale-<label>`](../appendices/entities.md#scale) is REQUIRED to disambiguate different atlas 'scales',
571571
when the atlas has more than one 'brain unit' or 'areal resolution', typically relating to the
572572
number of regions defined and the area they cover.
573573

0 commit comments

Comments
 (0)