Add many examples to schema and update some descriptions #394
Conversation
| mapping_provider: | ||
| description: URL pointing to the source that provided the mapping, for example | ||
| an ontology that already contains the mappings, or a database from which it was derived. | ||
| range: uri | ||
| instantiates: sssom:Propagatable | ||
| annotations: | ||
| propagated: true | ||
| examples: | ||
| - value: https://www.ohdsi.org/ |
There was a problem hiding this comment.
I think the description needs to be updated here. These URIs don't actually point to resources, so what are you supposed to do with this? This is more of a comment string since I'm not sure there's a good way to actually capture this information unless it's supposed to point to a metadata file or the source data itself
| mapping_cardinality: | ||
| description: A string indicating whether this mapping is from a 1:1 (the subject_id | ||
| maps to a single object_id), 1:n (the subject maps to more than one object_id), | ||
| n:1, 1:0, 0:1 or n:n group. Note that this is a convenience field that should be derivable | ||
| from the mapping set. | ||
| range: mapping_cardinality_enum | ||
| examples: | ||
| - value: "1:1" |
There was a problem hiding this comment.
can you make this exhaustive?
and more specifically, give examples of one-to-one and one-to-many mappings, with an explanation of why they have these qualities
There was a problem hiding this comment.
The enum definition is exhaustive; the examples are just cherry-picked. You can see all the enums and what they mean on the enum page (which is linked from the slot/field/column page).
See #392
this PR adds examples to most slots related to mappings, and updates some descriptions.
docs/have been added/updated if necessarymake testhas been run locallyIf you are proposing a change to the SSSOM metadata model, you must
examples/see_alsofield of the linkml modelsee_alsofield of the linkml model[Add a description, mentioning at least relevant #ISSUE and how it was addressed. A bulleted list of all changes performed by the PR is is helpful.]