Name the built-in profile for the platform it describes, not its ontology - #225
Merged
Conversation
…logy
The profile was called jerm, after the ontology underneath it, so anyone
looking for the model to describe data for FAIRDOM-SEEK had to know that JERM
is what SEEK is built on. It is now seek, titled SEEK, and its description says
plainly that it is the model SEEK stores research in.
The ontology keeps its name: jerm: is still the namespace the export emits, and
JERM is still what the docs call the model underneath. Only the profile a user
picks from a list is renamed.
No facade accessor replaces metaseed.jerm(): it was sugar for
ProfileFacade("jerm") that nothing referenced, and a top-level name of seek
would shadow metaseed.seek, the adapter that talks to a SEEK instance.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The profile was called
jerm, after the ontology underneath it. Anyone looking for the model to describe data for FAIRDOM-SEEK had to already know that JERM is what SEEK is built on — the name told them nothing.It is now
seek, titled SEEK, and its description says what it is: "The data model FAIRDOM-SEEK stores research in. Built on JERM (Just Enough Results Model), it extends ISA with models, SOPs and further asset types. Choose this to describe metadata you intend to publish to a SEEK instance."What is not renamed
The ontology.
jerm:is still the namespace the export emits,http://jermontology.org/ontology/JERMOntology#is still what SEEK types its resources with, and the docs still call the underlying model JERM. Only the profile a user picks from a list changed.No replacement accessor
metaseed.jerm()is removed rather than renamed. It was three lines of sugar forProfileFacade("jerm")and nothing referenced it — and a top-level name ofseekwould shadowmetaseed.seek, the adapter that talks to a SEEK instance, makingfrom metaseed import seekambiguous.ProfileFacade("seek")is the way in.docs/specification/api-contract.mdrecords this, since the public-API gate checks that document against__all__.Breaking
A dataset built against
jerm/1.0will not resolve its profile until it namesseek/1.0. Accepted as early-development churn.2698 tests pass; docs, the profile page, mkdocs nav, CLI examples and the merge guide all updated.