Added Bioschemas annotation #11
Conversation
|
Thanks, @egonw! Do you think you could update the PR description with a few sentences describing what having the bioschemas annotations accomplishes? I would also like to include that on the website/readme |
|
@cthoyt, done. cc @AlasdairGray |
Some resources in bioversions don't have a prefix in bioregsitry, and therefore it's not easy to construct a URL. I made an additional issue (biopragmatics#13) to better keep track of homepages in the data file used to generate this website, so I'll come back to this later
|
I've made a few updates and added a slightly edited version of the description text. I'll give @AlasdairGray some time to comment until the end tomorrow, and merge if he doesn't have any suggestions for improvement. |
|
What specifically are you wanting me to review? |
🤷 I guess it's just good to keep you in the loop @AlasdairGray ! Is there anything else you think would be useful to write in the header about Bioschemas and Bioversions? |
|
Can you point me to a webpage or a file to have a look at? |
|
If you click the "files changed" tab at the top of this PR page, you can see the 2 changes in this PR: the short text describing Bioschemas and then the actual implementation of the json-ld embedding |
docs/index.md
Outdated
| { | ||
| "@context": "https://schema.org", | ||
| "@type":"Dataset", | ||
| "http://purl.org/dc/terms/conformsTo": { |
There was a problem hiding this comment.
If you are claiming conformance, then you will need to add some more properties:
- description (this is needed for Google dataset search)
- identifier
- keywords
- license
There was a problem hiding this comment.
Hmm these metadata aren't currently readily available in the Bioversions repo. In general, it's a huge pain to figure out the license for most of these resources, too (they are not well-annotated). Maybe I can merge this then mark those as todo's for later, which might require bringing in more information from the Bioregistry on the build of the YAML file that the Bioversions website gets autogenerated from
There was a problem hiding this comment.
I can appreciate the challenges you are referring to. At the moment, Bioschemas does not enforce compliance, but we are planning to move to flagging resources that are not compliant when they claim to be. Perhaps just removing the conformsTo lines would be sufficient.
If you can get the descriptions then that will help get your data into the Google dataset search.
|
@AlasdairGray really appreciate the feedback! I will make a new issue with some follow-up work that needs to be done to conform to parts of this. |
From the Bioschemas website:
This can be on the original website itself (like on WikiPathways), but also on website that index it or have further information about it. The further information here, for example, is the link to the BioRegistry. The JSON-LD annotation will make it easier for other tools to recognize the content of the table. This includes the Google Dataset finder, besides Bioschemas itself.