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.

Sign up for GitHub

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

Jump to bottom

Add new slot "mapping_status" (mapping lifecycle) to SSSOM core model #347

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Add new slot "mapping_status" (mapping lifecycle) to SSSOM core model #347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ff01d6
Add mapping_status example
matentzn Jan 31, 2024
8cdcefa
Add mapping_status slot to SSSOM data model
matentzn Jan 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 20 additions & 0 deletions examples/schema/mapping_status.sssom.tsv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#curie_map:
# owl: http://www.w3.org/2002/07/owl#
# rdf: http://www.w3.org/1999/02/22-rdf-syntax-ns#
# rdfs: http://www.w3.org/2000/01/rdf-schema#
# semapv: https://w3id.org/semapv/vocab/
# skos: http://www.w3.org/2004/02/skos/core#
# sssom: https://w3id.org/sssom/
# orcid: https://orcid.org/
# get: https://global-ecosystems.org/explore/
# alum8: http://www.neii.gov.au/def/voc/ACLUMP/australian-land-use-and-management-classification/
#mapping_set_id: https://w3id.org/sssom/commons/examples/mapping_status.sssom.tsv
#license: "https://creativecommons.org/publicdomain/zero/1.0/"
#creator_id: orcid:0000-0002-3884-3420
#mapping_provider: "https://w3id.org/sssom/core_team"
#comment: This is an example file for the SSSOM for illustration only. Its contents are entirely fabricated.
subject_id predicate_id object_id mapping_justification author_id mapping_date status comment
alum8:Marsh-or-wetlandsaline skos:exactMatch get:groups/MFT1.3 semapv:ManualMappingCuration orcid:0009-0001-6090-9959 2023-12-01 draft
alum8:Marsh-or-wetlandsaline skos:exactMatch get:groups/MFT1.3 semapv:ManualMappingCuration orcid:0000-0002-2934-5497 2024-01-03 reviewed Looks Ok but let's check with Piers
alum8:Marsh-or-wetlandsaline skos:exactMatch get:groups/MFT1.3 semapv:ManualMappingCuration orcid:0000-0002-2568-59457 2024-01-10 approved Mapping has been approved by Pier and team.
Copy link
Member

Choose a reason for hiding this comment

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

I don't get what's the difference between approved and published based on this example, also this doesn't match the enum values

Copy link

Choose a reason for hiding this comment

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

There is commonly a delay between approval and the actual release, which may be phased with other items or on pre-defined calendar dates.

alum8:Marsh-or-wetlandsaline skos:exactMatch get:groups/MFT1.3 semapv:ManualMappingCuration orcid:0000-0002-2934-5497 2024-01-13 published
Copy link
Member

Choose a reason for hiding this comment

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

if the mapping is in a document, then it's published, so not really sure why this even exists

Copy link

Choose a reason for hiding this comment

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

That view may hold in amongst developers, but not in the statutory (government) sector or even amongst academics (who regularly withhold information 'until the journal article appears').

28 changes: 28 additions & 0 deletions src/sssom_schema/schema/sssom_schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,21 @@ enums:
"1:0": One-to-none mapping
"0:1": None-to-one mapping
"n:n": Many-to-many mapping
status_enum:
permissible_values:
draft:
description: "Indicates the mapping is in an early, unrefined form. This status is typically used for works in progress that are not yet ready for formal review or publication."
submitted:
description: "Represents the stage where the mapping has been submitted for review but has not yet been evaluated. This status is used after initial development and indicates readiness for external assessment."
reviewed:
description: "Denotes that the mapping has been reviewed by peers or evaluators, but it has not yet been formally accepted. This stage involves critical evaluation and may require revisions based on feedback."
accepted:
description: "Used when the mapping has been formally accepted for publication. This status indicates that it has passed the review phase and is awaiting publication."
published:
description: "Indicates that the mapping is officially published and publicly available. This is the final status and signifies that the work has completed all prior stages successfully."
withdrawn:
description: "Used if the mapping has been retracted or removed from consideration or publication. This can occur for various reasons, such as discovery of errors, author's decision, or other critical issues."


types:
EntityReference:
Expand Down Expand Up @@ -569,6 +584,18 @@ slots:
by tool providing additional informative information.
slot_uri: rdfs:comment
range: string
mapping_status:
description: Specifies the current stage in the lifecycle of an ontology mapping.
It represents various phases ranging from initial draft creation to final publication or withdrawal.
It helps in tracking the progress and state of the mapping, providing clear indicators of its readiness, review status, and overall development phase.
range: status_enum
see_also:
- https://github.com/mapping-commons/sssom/issues/345
- https://github.com/mapping-commons/sssom/blob/master/examples/schema/mapping_status.sssom.tsv
examples:
- value: draft
description: Draft status indicates that the mapping has been suggested, but not been reviewed or accepted by the mapping provider.

classes:
mapping set:
description: Represents a set of mappings
Expand Down Expand Up @@ -635,6 +662,7 @@ classes:
- mapping_cardinality
- mapping_tool
- mapping_tool_version
- mapping_status
- mapping_date
- publication_date
- confidence
Expand Down