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

Best way to have more support for termURL in json related to tabular files ? #1497

Open
neurorepro opened this issue May 22, 2023 · 3 comments
Assignees
Labels
enhancement New feature or request units

Comments

@neurorepro
Copy link

Having termURL fields as described here is great, but it seems limited to the column names and not e..g. to the categorical Levels.

For example, imagining we have the group column in our tabular data for participants and want to indicate different subgroups of Alzheimer's subjects (AD, MCI, NC) with a term URL for each, how we would do that ?

  "group": {
      "Description": "Alzheimer's subgroups",
      "Levels": {
          "AD": "Alzheimer's disease", # want to indicate `termURL` http://terminology/AD.html here
          "MCI": "Mild cognitive impairment" # want to indicate `termURL` http://terminology/MCI.html here
          ...
      }
  }

Is the only solution for now to replace the level description with the URL itself ? Are there any developments planned for a more formal description ? A first step could be nested description/termURL for levels as in:

  "group": {
      "Description": "Alzheimer's subgroups",
      "Levels": {
          "AD": {
            "Description": "Alzheimer's disease", 
            "termURL": "https://terminology/AD.html"
           }
          "MCI": {
            "Description": "Mild cognitive impairment",
            "termURL": "https://terminologyMCI.html"
          }
          ...
      }
  }

Note that it could be useful to also have this feature applied to Units as in:

"volume": {
    "Description": "Volume of X",
    "Units": {
      "Description": "millilitre",
      "termURL": "https://terminology/mL.html"
    }
}
@neurorepro neurorepro changed the title Best way to have more support for termURL in tabular files ? Best way to have more support for termURL in json associated to tabular files ? May 22, 2023
@neurorepro neurorepro changed the title Best way to have more support for termURL in json associated to tabular files ? Best way to have more support for termURL in json related to tabular files ? May 22, 2023
@effigies
Copy link
Collaborator

Yes, the insufficiency of our column descriptions has come up recently. I like the idea of expanding plain-text descriptions to description fields that allow richer annotations. Thus "AD": "Alzheimer's disease" becomes shorthand for "AD": {"Description": "Alzheimer's disease"} and tools can easily perform this conversion and enable addition of new fields.

@surchs I would be interested in your thoughts here.

There's a general problem in BIDS, which is that we don't want to make it difficult to start structuring your data, but it would be good to find ways to enable "promoting" first-pass annotations to rich annotations. I would also like to do this with dataset authors...

@Remi-Gau
Copy link
Collaborator

I believe this can "almost" be closed as most of it was adressed in #1603

The only part that is not yet covered would be allowing both description and URI for things like Units.

"volume": {
    "Description": "Volume of X",
    "Units": {
      "Description": "millilitre",
      "termURL": "https://terminology/mL.html"
    }
}

@Remi-Gau Remi-Gau added the enhancement New feature or request label Sep 26, 2023
@Remi-Gau
Copy link
Collaborator

potentially related to this: #615

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request units
Projects
Status: No status
Development

No branches or pull requests

3 participants