Skip to content

Commit

Permalink
Clarifying descriptions of various properties (#306)
Browse files Browse the repository at this point in the history
Resolves #304 

In this PR, we 

- clarify the scope of a number of SSSOM properties (e.g author,
reviewer and creator_id properties are clarified to be URIs, rather than
"strings")
- Drop the use of syntactic concerns such "pipe-seperated" which do not
belong in a general spec
- fix some minor typos
  • Loading branch information
matentzn authored Jul 27, 2023
1 parent 95ea414 commit 3d9c57b
Showing 1 changed file with 13 additions and 16 deletions.
29 changes: 13 additions & 16 deletions src/sssom_schema/schema/sssom_schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -298,40 +298,37 @@ slots:
the mapping. The creator is the agent that put the mapping in its published form,
which may be different from the author, which is a person that was actively involved
in the assertion of the mapping.
Recommended to be a (pipe-separated) list of ORCIDs or otherwise
identifying URLs, but any identifying string (such as name and affiliation)
is permissible.
Recommended to be a list of ORCIDs or otherwise
identifying URIs.
slot_uri: dcterms:creator
range: EntityReference
multivalued: true
creator_label:
description: A string identifying the creator of this mapping. In the spirit of
provenance, consider to use creator_id instead.
provenance, consider using creator_id instead.
range: string
multivalued: true
author_id:
description: Identifies the persons or groups responsible for asserting the mappings.
Recommended to be a (pipe-separated) list of ORCIDs or otherwise
identifying URLs, but any identifying string (such as name and affiliation)
is permissible.
Recommended to be a list of ORCIDs or otherwise
identifying URIs.
slot_uri: pav:authoredBy
range: EntityReference
multivalued: true
author_label:
description: A string identifying the author of this mapping. In the spirit of
provenance, consider to use author_id instead.
provenance, consider using author_id instead.
range: string
multivalued: true
reviewer_id:
description: Identifies the persons or groups that reviewed and confirmed the mapping.
Recommended to be a (pipe-separated) list of ORCIDs or otherwise
identifying URLs, but any identifying string (such as name and affiliation)
is permissible.
Recommended to be a list of ORCIDs or otherwise
identifying URIs.
range: EntityReference
multivalued: true
reviewer_label:
description: A string identifying the reviewer of this mapping. In the spirit of
provenance, consider to use reviewer_id instead.
provenance, consider using reviewer_id instead.
range: string
multivalued: true
license:
Expand All @@ -340,7 +337,7 @@ slots:
range: uri
slot_uri: dcterms:license
subject_source:
description: URI of ontology source for the subject.
description: URI of vocabulary or identifier source for the subject.
range: EntityReference
examples:
- value: obo:mondo.owl
Expand All @@ -354,7 +351,7 @@ slots:
- value: http://purl.obolibrary.org/obo/mondo/releases/2021-01-30/mondo.owl
description: (A persistent Version IRI pointing to the Mondo version '2021-01-30')
object_source:
description: IRI of ontology source for the object. Version IRI preferred.
description: URI of vocabulary or identifier source for the object.
range: EntityReference
examples:
- value: obo:mondo.owl
Expand Down Expand Up @@ -415,12 +412,12 @@ slots:
the match is correct, where 1 denotes total confidence.
range: double
subject_match_field:
description: A tuple of fields (term annotations on the subject) that was used
description: A list of properties (term annotations on the subject) that was used
for the match.
range: EntityReference
multivalued: true
object_match_field:
description: A tuple of fields (term annotations on the object) that was used
description: A list of properties (term annotations on the object) that was used
for the match.
range: EntityReference
multivalued: true
Expand Down

0 comments on commit 3d9c57b

Please sign in to comment.