-
Notifications
You must be signed in to change notification settings - Fork 24
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
Front page of SSSOM website desperately needs to list what the columns in an SSSOM file are/can be #392
Comments
You mean something like this? If not, provide me with an example page and I will make it happen! Once we settle on how it will look like, we can add more examples to the actual schema. Draft 1 of a simple overview of allowed slotsMapping SetRepresents a set of mappings
MappingRepresents an individual mapping between a pair of entities
Mapping RegistryA registry for managing mapping sets. It holds a set of mapping set references, and can import other registries.
Mapping Set ReferenceA reference to a mapping set. It allows to augment mapping set metadata from the perspective of the registry, for example, providing confidence, or a local filename or a grouping.
PrefixNo description
|
“Slot name” is LinkML jargon, should be “Field Name” for us mere mortals |
What I need is to remember what the columns are in SSSOM file. So the only thing that should be there is the "Mappings" header and explicitly not the Mapping Sets header or anything else. And it should be "Column" instead of "Slot name" or "Field name" Can we have another column in this table that is either "Required", "Recommended", or "Optional"? And sort the columns a bit better so I don't get some of the extraneous stuff towards the top of the list like "subject_category" We need to rename It's confusing with the example column to tell the difference between fields that take a list of things or a single thing. Maybe stick to a single example for each Any column that has N/A for the example means we need to do some thinking! We need an example for everything |
Its a quite personal preference IMO, but OK; There are already a few groups using SSSOM in rdf format so I want to be careful to completely superimpose Table terminology (column etc). See compromise below.
I did, but its quite a problematic column due to our latest changes to the model to accommodate for literal mappings. We probably need to hardcode the values for subject_id and object_id as these are no longer documented on schema level to be required (the requirement is encoded in the spec and a few rules in the data model) to accommodate for literal mappings.
Not 100% sure, as the order is the order in which they should appear in the SSSOM table as well... How strong do you feel about this?
I did, but not straight, see example and reasoning above.
OK.
Agreed but that's a bit more involved, first lets get the page up we have right now. V2
|
…ce (#393) Resolves #392 This PR updates the front page to show at a glance the mapping level metadata fields, and a better view of a SSSOM example table. - [X] `docs/` have been added/updated if necessary - [ ] `make test` has been run locally - [ ] tests have been added/updated (if applicable) - [ ] [CHANGELOG.md](https://github.com/mapping-commons/sssom/blob/master/CHANGELOG.md) has been updated.
See #392 this PR adds examples to most slots related to mappings, and updates some descriptions. - [ ] `docs/` have been added/updated if necessary - [ ] `make test` has been run locally - [ ] tests have been added/updated (if applicable) - [ ] [CHANGELOG.md](https://github.com/mapping-commons/sssom/blob/master/CHANGELOG.md) has been updated. If you are proposing a change to the SSSOM metadata model, you must - [ ] provide a full, working and valid example in `examples/` - [ ] provide a link to the related GitHub issue in the `see_also` field of the linkml model - [ ] provide a link to a valid example in the `see_also` field of the linkml model - [ ] run SSSOM-Py test suite against the updated 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.]
@cthoyt @jamesamcl Thanks so much for your help; its done: https://mapping-commons.github.io/sssom/ Also, I have updated the LinkML pages while we are at it a bit along the same lines:
Both need work but I think they are already 150% better than before! |
it's near impossible to find the list of all of the fields in SSSOM. This should be the third thing on the https://mapping-commons.github.io/sssom/ after 1. an explanation of what SSSOM is/what it's for and 2. an example SSSOM file
As a potential SSSOM user, I don't ever ever ever want to look at LinkML-like documentation. It is confusing and makes my brain hurt because I am not a LinkML developer.
What I really need is a list of the fields, a description of what's goes in them, and an example for each. All of this needs to be in a table and on the front page after the two other things
The text was updated successfully, but these errors were encountered: