Skip to content

[ENH] add task metadata to PET #1196

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
Aug 25, 2022
Merged

[ENH] add task metadata to PET #1196

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d3b9de8
add task metadata to PET
Remi-Gau Aug 12, 2022
ac6cdc3
fix typo
Remi-Gau Aug 12, 2022
c5db963
update schema
Remi-Gau Aug 12, 2022
a3fea1a
fix metadata order
Remi-Gau Aug 12, 2022
28f1036
add task in entites in schema selector
Remi-Gau Aug 12, 2022
bd8f042
Merge branch 'master' into task_pet
sappelhoff Aug 25, 2022
fd39d09
fix indentation
sappelhoff Aug 25, 2022
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
18 changes: 18 additions & 0 deletions src/04-modality-specific-files/09-positron-emission-tomography.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,24 @@ and a guide for using macros can be found at

All reconstruction-specific parameters that are not specified, but one wants to include, should go into the `ReconMethodParameterValues` field.

#### Task

<!-- This block generates a metadata table.
The definitions of these fields can be found in
src/schema/objects/metadata.yaml
and a guide for using macros can be found at
https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
-->
{{ MACROS___make_metadata_table(
{
"TaskName": ("RECOMMENDED", "If used to denote resting scans, a RECOMMENDED convention is to use labels beginning with `rest`.")
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Usually this is REQUIRED for almost all datatypes (except for behavioral), for backward compatibility I suspect it is better to keep it RECOMMENDED.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added an extra comment that tries to make it clear that eventhough task is not required for PET for resting scans, if one decided to use it, it would be better to stick to the convention other datatypes use.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that it is best to keep recommended, and great that you added the extra comment.

"Instructions": ("RECOMMENDED", "This is especially important in context of resting state recordings and distinguishing between eyes open and eyes closed paradigms."),
"TaskDescription": "RECOMMENDED",
"CogAtlasID": "RECOMMENDED",
"CogPOID": "RECOMMENDED",
}
) }}

#### Example (`*_pet.json`)

```JSON
Expand Down