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

[ENH] add matches and source_entity to glossary #1781

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
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
27 changes: 27 additions & 0 deletions src/schema/objects/entities.yaml
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

adding those in the entities.yml for now

not entirely convinced this is the best place

Copy link
Collaborator

Choose a reason for hiding this comment

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

perhaps just the glossary? in entities it will interact with the schema, right?

Copy link
Collaborator

Choose a reason for hiding this comment

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

okay, there's no "glossary.yml" hehehehe sorry for shooting before thinking.

Original file line number Diff line number Diff line change
Expand Up @@ -422,3 +422,30 @@ tracksys:
may be longer and more human readable.
type: string
format: label

matches:
name: matches
display_name: matches
description: |
`matches` is used as a placeholder in BIDS filenames templates to denote that several files
share exactly the same sequence of entities and labels in their basename.

For example, in the following filename template

```Text
<matches>_bold.nii.gz
<matches>_events.tsv
<matches>_events.json
```

`<matches>` could correspond to `sub-control01_task-nback_run-1`.

source_entities:
name: source_entities
display_name: source entities
description: |
`source_entities` is used as a placeholder in BIDS derivatives filenames templates.

`source_entities` MUST be the entire source filename, with the omission of
the source suffix and extension. One exception to this rule is filename
entities that are no longer relevant.