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

HED-SCORE library schema 1.0.0 release #54

Merged
merged 13 commits into from
Jan 27, 2023
Merged

Conversation

tpatpa
Copy link
Collaborator

@tpatpa tpatpa commented Jan 19, 2023

Following an extensive revision process of the schema, we can officially release it.

tpatpa added 10 commits October 4, 2022 10:08
Changes following Sandor Beniczky's comments regarding duplications in the current SCORE terminology.
Additional changes following Sandor Beniczky's comments regarding duplications in the current SCORE terminology.
Added the (previously excluded) section for "Rhythmic and periodic patterns in critically ill patients" following Sandor Beniczky's comments.
The schema was validated and converted using HED online tools.
Updated Prologue and Epilogue.

The schema was validated and converted using HED online tools.
The final review of the HED-SCORE library schema was completed, allowing us to proceed with setting the prerelease version as the official release.
@IanCa
Copy link
Member

IanCa commented Jan 19, 2023

I was working on the tools and fixed a bug finding the following issue:

The term "Body-part" is already used in the standard schema.
Item/Biological-item/Anatomical-item/Body-part
Finding-property/Location-property/Body-part

I didn't find any other new duplicates, but I will update you immediately if I do...

@tpatpa
Copy link
Collaborator Author

tpatpa commented Jan 19, 2023

Thanks!
Body-part in HED-SCORE is used to characterize semiologic findings and, indeed, partially overlaps with Item/Biological-item/Anatomical-item/Body-part.

/Finding-property/Location-property/Body-part:

  • Body-part-eyelid
  • Body-part-face -> /Item/Biological-item/Anatomical-item/Body-part/Head/Face
  • Body-part-arm -> /Item/Biological-item/Anatomical-item/Body-part/Upper-extremity
  • Body-part-leg -> /Item/Biological-item/Anatomical-item/Body-part/Lower-extremity
  • Body-part-trunk -> /Item/Biological-item/Anatomical-item/Body-part/Torso
  • Body-part-visceral
  • Body-part-hemi

With this proposal, specifically, the use of relatedTag and suggestedTag attributes with standard tags, we can partially resolve this by adding suggestedTag to /Finding-property/Location-property pointing to the standard tags in Item/Biological-item/Anatomical-item/Body-part.

Any thoughts on whether there is room for the rest of the SCORE tags (eyelid, visceral, hemi) in the standard schema?

@VisLab @dorahermes @dungscout96 @IanCa @happy5214

@VisLab
Copy link
Member

VisLab commented Jan 20, 2023 via email

@tpatpa
Copy link
Collaborator Author

tpatpa commented Jan 20, 2023

Great, thank you @VisLab ! Looking forward to discussing this further.
Once this version is merged and used by the HED tools, we can fully validate the HED-SCORE bids-example ! 🥳

'Body-part' subtree was renamed to remove potential conflicts with future releases of SCORE (specifically if "partnering" with a standard schema).

Schema had no HED-3G validation errors and was converted using HED online tools (https://hedtools.ucsd.edu/hed2/schema).
@tpatpa tpatpa assigned VisLab and dorahermes and unassigned VisLab Jan 26, 2023
Copy link
Member

@dorahermes dorahermes left a comment

Choose a reason for hiding this comment

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

It is difficult for me to compare the old and new version, because the name of the document has changed with the new version.

  • The changes to body-part all look good!
  • It seems like 1.0.0 includes the new body part section, but the old prologue?

@@ -0,0 +1,1106 @@
HED library="score" version="1.0.0"

'''Prologue'''
Copy link
Member

Choose a reason for hiding this comment

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

The prologue still seems to be an old prologue, rather than the new one with the references?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

There is more information in the epilogue!
Then both are shown in the browser viewer's 'Schema information' section.

Copy link
Member

Choose a reason for hiding this comment

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

Ok, thanks!

@VisLab
Copy link
Member

VisLab commented Jan 27, 2023

@tpatpa I noticed that score_0.0.1 is removed. Since we didn't officially tag it as a release, I guess that is okay, but I wanted to verify. We're going to have to develop a policy about how this is handled.

I have created a score branch. Would you please change your PR to merge into the score branch.
We need to rerun the latest schema validators and do a final check before creating an official release.
It will be easier to do that on a separate branch. Thanks!

@tpatpa
Copy link
Collaborator Author

tpatpa commented Jan 27, 2023

Yes, score_0.0.1 was removed on purpose. I feel it is too preliminary... But, I can, of course, restore if needed.

@VisLab
Copy link
Member

VisLab commented Jan 27, 2023

@tpatpa @dorahermes @dungscout96 one other question.... This is about how we should handle prereleases.

We have links to both current and prerelease versions in the README and other places. Eventually @dungscout96 is going to change the schema browser so that all of these are available from one browser. However, until this happens if we completely remove the prerelease these links will break. Even after there is a merged viewer, it would be good to have an anchor point to a prerelease.

When we do the actual release with tags etc. we could create a copy of 1.0.0 as 1.0.1 prelease so that there will be an anchor point going forward. If there are other ideas on this let me know.

@tpatpa tpatpa changed the base branch from main to score January 27, 2023 16:18
Created a copy of score_1.0.0 as score_1.0.1 as the prerelease version for viewers and version stability.
@dorahermes
Copy link
Member

lgtm!

@VisLab VisLab merged commit cf734ab into hed-standard:score Jan 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants