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

Update StudyResult.dataItem property #166

Merged
merged 1 commit into from
Jul 9, 2024

Conversation

mbrush
Copy link
Contributor

@mbrush mbrush commented Jul 4, 2024

Here I update StudyResult.dataItem property to align with analogous paradigm for qualifier specialization

Background and Motivation

In issue #134 @larrybabb proposed that profiles can define specific qualifiers as ‘new’ properties as long as they are named as qualifiers. @mbrush clarified that these are not truly ‘new’ – as conceptually they specialize the core-im Statement.qualifier property.

The use of StudyResult.dataItem property in StudyResult profiles is quite analogous, in that profiling often requires defining >1 specialization of this property for different specific data types.

Changes

In this PR, we update the definition of StudyResult.dataItem in the core-im to support this paradigm and align with how Statement.qualifier is defined in PR #160

Specifically:

  • removed the existing dataItems property
  • replaced it with a ‘dataItem’ property (singular, consistent with it not taking an array in the core-im)
  • made it take an ‘object’ (which by my understanding covers strings)
  • gave it a clear and informative free-text description
  • added a ‘comment’ that explains how this property can get profiled into >1 more specific properties.

In the future we might consider some type of flag/keyword on this core-im property to explicitly mark it as amenable to 1:m specialization in profiles – if this helps with conceptual clarity or computational validation.

Here I update StudyResult.dataItem property to align with analogous paradigm for qualifier specialization


In #134 @larrybabb  proposed that profiles can define specific qualifiers as ‘new’ properties as long as they are named as qualifiers.  @mbrush clarified that these are not truly ‘new’ – as conceptually they specialize the core-im `Statement.qualifier` property. 

The use of `StudyResult.dataItem` property in StudyResult profiles is quite analogous, in that profiling often requires defining >1 specialization of this property for different specific data types. 

In this PR, we update the definition of StudyResult.dataItem in the core-im to support this paradigm and align with how `Statement.qualifier` is defined in PR #___

Specifically: 
- removed the existing `dataItems` property
- replaced it with a ‘dataItem’ property (singular, consistent with it not taking an array in the core-im)
- made it take an ‘object’  (which by my understanding covers strings)
- gave it a clear and informative free-text description
- added a ‘comment’ that explains how this property can get profiled into >1 more specific properties. 

In the future we might consider some type of flag/keyword on this core-im property to explicitly mark it as amenable to 1:m specialization in profiles – if this helps with conceptual clarity or computational validation.
@larrybabb larrybabb merged commit 596b003 into 1.x Jul 9, 2024
3 checks passed
@larrybabb larrybabb deleted the mbrush-patch-2-study-result-dataItem-updates branch July 9, 2024 01:32
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.

2 participants