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

add participants.json with Levels as objects #413

Merged
merged 3 commits into from
Nov 3, 2023
Merged

add participants.json with Levels as objects #413

merged 3 commits into from
Nov 3, 2023

Conversation

Remi-Gau
Copy link
Contributor

closes #412

@Remi-Gau
Copy link
Contributor Author

@surchs I may need your help on this

Copy link
Member

@sappelhoff sappelhoff left a comment

Choose a reason for hiding this comment

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

We are getting this issue:

  	1: [ERR] Invalid JSON file. The file is not formatted according the schema. (code: 55 - JSON_SCHEMA_VALIDATION_ERROR)
		./participants.json
			Evidence: ['sex'].Levels['F'] should be string
		./participants.json
			Evidence: ['sex'].Levels['M'] should be string
		./participants.json
			Evidence: ['sex'].TermURL should match format "uri"

So we probably need to tell the (legacy JS) validator / the schema that levels as objects are fine (not only string)

And we furthermore need to add TermURLs for:

  • age
  • sex
  • female
  • male
  • Hispanic
  • MiddleEastern
  • Caucasian/African/NativeSouthAmerican
  • Caucasian
  • Asian/Caucasian
  • Asian
  • Right
  • Left
  • Handedness
  • dominant_hand
  • gender

@surchs
Copy link
Contributor

surchs commented Oct 27, 2023

Hey folks! I think the variables listed by @sappelhoff fall into two levels with different answered by the TermURL:

  • concepts (age, sex, handedness): "what is it ABOUT"
  • values (27, female, left-handed): "what does it MEAN"

there are a ton of possible TermURLs for either, but I think it's a good idea to pick the TermURLs for values about the same concept from the same list. For example this could be a list:

What ontology to pick terms from is probably a bit beyond what BIDS can do in the examples / recommendations. But maybe we can provide some rule-of-thumb, i.e.: take from a list that is actively maintained, ideally widely used, ...

7t_trt/participants.json Outdated Show resolved Hide resolved
ds000117/participants.json Outdated Show resolved Hide resolved
ds000117/participants.json Outdated Show resolved Hide resolved
ds008/participants.json Outdated Show resolved Hide resolved
ds101/participants.json Outdated Show resolved Hide resolved
ds110/participants.json Outdated Show resolved Hide resolved
ds116/participants.json Outdated Show resolved Hide resolved
eeg_ds000117/participants.json Outdated Show resolved Hide resolved
ds114/participants.json Outdated Show resolved Hide resolved
ds114/participants.json Outdated Show resolved Hide resolved
@sappelhoff sappelhoff marked this pull request as ready for review November 3, 2023 10:59
"TermURL": "http://purl.obolibrary.org/obo/PATO_0001894",
"Levels": {
"D": {
"Description": "D"
Copy link
Member

Choose a reason for hiding this comment

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

I have removed "TermURL" here for now. If somebody knows what this means, please feel free to clarify.

@sappelhoff
Copy link
Member

sappelhoff commented Nov 3, 2023

Okay:

  • passes on master ✅
  • adds correct TermURLs to many examples, exemplifying the new feature ✅
  • I dropped everything that was unclear but wasn't really needed ✅
    • feel free to add later: for example what's the "D" sex?
    • or a TermURL for Caucasian/African/NativeSouthAmerican
  • better done than perfect ✅

Will merge.

Thanks for the start @Remi-Gau and thanks for the support @surchs!

EDIT and of course thanks to @effigies for adding validator support.

@sappelhoff sappelhoff merged commit b6e5234 into master Nov 3, 2023
6 of 12 checks passed
@sappelhoff sappelhoff deleted the levels branch November 3, 2023 11:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update examples to demonstrate using object for levels in sidecar for TSV
3 participants