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 entryTypeDefinition description #92

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

mbaudis
Copy link
Member

@mbaudis mbaudis commented Jun 19, 2023

The parameter descriptions in the EntryTypeDefinitions schema seem somewhat hard to parse and potentially misleading - this is a go at cleaning them up a bit.

The parameter descriptions in the EntryTypeDefinitions schema seem somewhat hard to parse and potentially misleading - this is a go at cleaning them up a bit.
It is not clear how to use ontologyTermForThisType w/o examples (i.e. terms for biosample, individual... - added some but incomplete...) and there is also a logical duplication having a "unique" id and an ontology term. Overall this should be clarified but the current modification seems (a) sensible (step).
@mbaudis
Copy link
Member Author

mbaudis commented Jun 19, 2023

It is not clear how to use ontologyTermForThisType w/o examples (i.e. terms for biosample, individual... - added some but incomplete...) and there is also a logical duplication having a "unique" id and an ontology term. Overall this should be clarified but the current modification seems (a) sensible (step).

Copy link
Collaborator

@costero-e costero-e left a comment

Choose a reason for hiding this comment

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

I like the changes you made, as it makes it more clear to know what is an entry Type. Thank you. I approved the changes but I have a particular opinion (that maybe is wrong) for the entry Type description: Definition of an element or entry type, to describe each type of entry type included in a beacon
I think it would be better to not use "entry Type" in its own definition, maybe we could use "scope" here, as I see it as, correct me if I'm wrong, a similar term for entry Type. For example we could have something like: Definition of an element or scope of the element, to describe each type of entry type included in a beacon
The rest I see it correct and you are right we should extend the list of ontologyTermForThisType.

@mbaudis
Copy link
Member Author

mbaudis commented Jun 19, 2023

Definition of an element or scope of the element, to describe each type of entry type included in a beacon

Excellent!

@costero-e
Copy link
Collaborator

Definition of an element or scope of the element, to describe each type of entry type included in a beacon

Excellent!

Updated the definition with a new commit!

@jrambla
Copy link
Contributor

jrambla commented Jan 9, 2024

The purpose of ontologyTermForThisType is to allow a semantic description of the model.
A new model (e.g. on cancer registries) with a whole set of entryTypes, or a new entryType (e.g. File or a genomicFeature) would have this attribute to describe which type of thing that endpoint is.
It is NOT an identifier, but a mechanism for make the models shallowly semantic.

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.

None yet

3 participants