BioSchemas / specifications

Issue tracker, technical wiki, and example markup
https://bioschemas.org
54 stars 52 forks source link

proposal for gene pages from the Alliance of Genome Resources #225

Closed nathandunn closed 5 years ago

nathandunn commented 6 years ago

Here is a rough proposal we'd come up with for gene display pages at the MODs. We tried to incorporate the way all of the mods model and display gene pages and associated data, while doing what we hope is google best practices and incorporating existing standards and examples, especially WRT proteins.

This specific example:

https://gist.github.com/nathandunn/6fefd97f5a5a5578e302b4623e52f990

would be attached JSON-LD data to this gene page:

https://www.alliancegenome.org/gene/ZFIN:ZDB-GENE-001103-2

Validation:

https://search.google.com/structured-data/testing-tool/u/0/#url=https%3A%2F%2Fgist.githubusercontent.com%2Fnathandunn%2F6fefd97f5a5a5578e302b4623e52f990%2Fraw%2F0241e03e2548c2c71ab00802b176fec3f176f9c4%2FBioschemas%252520Example%2525203

Comments:

Questions:

JervenBolleman commented 6 years ago

Just quickly want to note you are falling into the Microdata additionalType trap. In JSON-LD this is just "@type".

nathandunn commented 6 years ago

@JervenBolleman Are you proposing that we replace additionalType with @type within our schema?

I think that sounds reasonable.

I'm not sure what the "Microdata additionalType trap" is, but it sounds dangerous.

JervenBolleman commented 6 years ago

@nathandunn sorry for the exaggeration ;) yes it's exactly what I meant. AdditionalType in schema.org mostly exists for Microdata syntax, JSON-LD has "@type" and RDFa has "typeof" which accepts lists/arrays Microdata does not have this.

additionalType | An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.

For info for www.uniprot.org I decided to put all schema.org in RDFa, mostly to avoid doubling page sizes by repeating every literal and id twice or more to have a JSON-LD part.

AlasdairGray commented 6 years ago

What is the relationship between this issue and #224?

AlasdairGray commented 6 years ago

This example will need to be updated if the proposal is accepted by the community.

nathandunn commented 6 years ago

@JervenBolleman Thanks. I updated the example to reflect this. I'm sure there will be more changes, though.

nathandunn commented 6 years ago

@AlasdairGray There is some overlap between #224 and this. I think, after talking with @kyook that we are replacing everything DataRecord with this as the greater specificity here is more desirable.

At a higher-level, I'm unsure if an entire MODs should be DataCatalog or a DataSet or something else entirely, but that is definitely something we could follow up on later. .

nathandunn commented 6 years ago

@AlasdairGray no problem updating the proposal with what is here (https://docs.google.com/document/d/1Cw9K25N1l-Lbet1cahJuFtYgNKiF76apGcCqJPSeuZg/edit#) with the exception that I don't think we should use DataRecord. If there is an example based on this, that would be great.

AlasdairGray commented 5 years ago

Can we close this issue based on the outcomes of the Biohackathon?

nathandunn commented 5 years ago

Note. Closing this based on outcome of the biohackathon. Working on new spec.