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.

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

Jump to bottom

[ENH] Add ContextURI to allow to define the context for the entity values #1939

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[ENH] Add ContextURI to allow to define the context for the entity values #1939

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions src/common-principles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -540,6 +540,7 @@ and a guide for using macros can be found at
"Units": "RECOMMENDED",
"Delimiter": "OPTIONAL",
"TermURL": "RECOMMENDED",
"ContextURI": "RECOMMENDED",
"HED": "OPTIONAL",
}
) }}
Expand Down Expand Up @@ -592,6 +593,20 @@ like in the example below.
}
```

The `ContextURI` can be used to provide a URL to a controlled vocabulary or ontology, or simply to provide a URL to a page that provides more context for the values in the column.
It is to be used, so if combined with the value in that value (`<label>` or `<index>`), it would establish a unique identifier for the entity to be used across BIDS datasets.
In the example below it would establish that `participant_id` is shared across datasets of the center, which would allow to differentiate center's subjects apart from subject ids used by other datasets used in the lab.

```JSON
{
"participant_id": {
"Description": "Unique identifier used for study subjects in the lab across studies",
"ContextURI": "https://thelab.example.com/term/subject/"
}
}
```


### Compressed tabular files

Large tabular information, such as physiological recordings, MUST be stored with
Expand Down
5 changes: 4 additions & 1 deletion src/modality-agnostic-files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,9 @@ to date of birth.

```JSON
{
"participant_id": {
"ContextURI": "http://thelab.example.com/term/subject/"
},
"age": {
"Description": "age of the participant",
"Units": "year"
Expand Down Expand Up @@ -422,7 +425,7 @@ about the questionnaire and `adhd_b` and `adhd_c_dx` correspond to individual
columns.

In addition to the keys available to describe columns in all tabular files
(`LongName`, `Description`, `Levels`, `Units`, and `TermURL`) the
(`LongName`, `Description`, `Levels`, `Units`, `TermURL`, and `ContextURI`) the
`participants.json` file as well as phenotypic files can also include column
descriptions with a `Derivative` field that, when set to true, indicates that
values in the corresponding column is a transformation of values from other
Expand Down
9 changes: 9 additions & 0 deletions src/schema/objects/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,6 +519,15 @@ Columns:
type: array
items:
type: string
ContextURI:
name: ContextURI
display_name: Context URI
description: |
URI establishing the context for the values of this data.
For example, https://thelab.example.com/term/subject/ if used for "participant_id"
could be used to non-ambigously link participant data acquisitions across datasets.
type: string
format: uri
ContinuousHeadLocalization:
name: ContinuousHeadLocalization
display_name: Continuous Head Localization
Expand Down