[ENH] add hemi entity to schema
#917
Conversation
src/schema/rules/entities.yaml
Outdated
| @@ -19,6 +19,7 @@ | |||
| - part | |||
| - recording | |||
| - processing | |||
| - hemi | |||
There was a problem hiding this comment.
From my reading of the specs this is the correct place for this one.
There was a problem hiding this comment.
We don't currently include any derivative patterns in the datatype rules, so this won't show up in the entity tables or any filename templates, which definitely makes things easier.
It looks like fMRIPrep places hemi after space (see the Surfaces, segmentations and parcellations from FreeSurfer section of https://fmriprep.org/en/stable/outputs.html#functional-derivatives). I don't think really matters for this PR, since the spec already seems to say that hemi should come first, but we may want to open a follow-up issue in fMRIPrep.
The only requests I'd like to make are the updated description, as well as a link to the entity appendix section in the spec text where hemi is mentioned.
Co-authored-by: Chris Markiewicz <effigies@gmail.com>
Done. But I realized that the other derivatives entities have no such links in the derivatives pages. Should we add them in another PR ?
Should I do it? |
| @@ -390,7 +390,7 @@ General fields: | |||
| "For example, **T1**: `'sub-<label>/ses-<label>/anat/" | |||
| "sub-01_T1w.nii.gz'` " | |||
| "**Surface**: `'/derivatives/surfaces/sub-<label>/ses-<label>/anat/" | |||
| "sub-01_desc-T1w_hemi-R_pial.surf.gii'` " | |||
| "sub-01_hemi-R_desc-T1w_pial.surf.gii'` " | |||
There was a problem hiding this comment.
small change in this example to make it bids derivatives compliant
I think that was just an oversight on my part. We should definitely link to the associated entity definition any time we reference an entity in the text. |
There was a problem hiding this comment.
LGTM! I'll open an issue about the fMRIPrep derivatives.
EDIT: I've opened nipreps/fmriprep#2620.
fixes #916
it had slipped through the cracks