Closed mbrush closed 1 year ago
Proposal:
publications
-> supporting publications
supporting publications
under supporting documents
supporting documents
definition: A referencable document that reports the statement expressed in an Association, or provides information used as evidence supporting this statement.supporting publications
definition: A publication that reports the statement expressed in an Association, or provides information used as evidence supporting this statement.Another issue here is to decide if the names of these properties should be plural or singular . . .
@mbrush - is it necessary to change 'publications' to 'supporting publications'? (totally doable, I just know this is a very widely used parameter and would require a lot of downstream changes. Alternatively, I could add supporting publications
as an alias of publications
).
also should (somewhat pedantically) note that supporting document
is currently in the model, and is not multivalued. Would the second part of this proposal make supporting documents
multivalued?
should 'supporting text' also become 'supporting texts' and be a child of 'supporting documents'?
should 'supporting data set' also be a child of 'supporting documents' ?
My thoughts on your questions @sierra-moxon:
publications
to supporting publications
, but IMO it is preferred (it is a more descriptive/informative name, and provides consistency with supporting documents
)supporting documents
was created at the request of TMKP, and they did not need it to be multivalued. But I think it should be, so support other use cases for this property.supporting text
should not be renamed, and is not a subproperty of supporting document
(it refers to a single span of text, not an entire document)supporting data set
should not be moved under supporting document
either, as IMO we should not consider a dataset to be a type of document. (This is consistent with how they are modeled in OBO ontologies like IAO)Re-opening this issue as additional questions regarding the representation of supporting documents have surfaced, and may warrant reconsideration of decisions made above.
Current Biolink representation:
### CLASSES ###
publication:
is_a: information content entity
description: >-
Any published piece of information. Can refer to a whole publication,
its encompassing publication (i.e. journal or book) or to a part of a
publication, if of significant knowledge scope (e.g. a figure, figure
legend, or section highlighted by NLP). The scope is intended to be
general and include information published on the web, as well as printed
materials, either directly or in one of the Publication Biolink
category subclasses.
slots:
- authors
- pages
- summary
- keywords
- mesh terms
- xref
. . .
### ASSOCIATION SLOTS ###
supporting documents:
is_a: association slot
description: >-
One or more referencable documents that report the statement expressed in an Association, or provide
information used as evidence supporting this statement.
range: uriorcurie
multivalued: true
examples:
- value: PMID:12345678
publications:
aliases: ["supporting publications"]
singular_name: publication
description: >-
One or more publications that report the statement expressed in an Association, or provide information used as
evidence supporting this statement.
is_a: supporting documents
multivalued: true
range: publication
Questions:
Confirm we want two slots to link to supporting docs/pubs.
Revisit idea or renaming to be more consistent.
Broaden supporting documents
and/or publications
definition to include the idea of documents supporting things besides Statements (e.g. StudyResults), and indicating that provenance information qualifies as supporting info:
Documents that provide information supporting the creation of a Statement or other Information Entity. Most often this slot is used to reference documents that report the Statement expressed in an Association, or provide evidence or provenance information supporting this Statement. Another common use is to reference documents that supported the creation of a Study Result object.
An issue here is that the publications
property currently an association slot, as its initial scope is to annotate Edges/Statements. But for linking other types of informational entities to pubs that support them (e.g. Study Results . . . .which are named things, not associations), an association slot is not appropriate (we would need a node property or predicate).
Voting on decisions that address 1-4 above is happening in Discussion #1234.
Closing, based on outcomes of voting in #1234 and final decisions documented in the supporting publications specification here.
At present, the most common Biolink edge property used in Attributes to hold supporting publications is
publications
.But Biolink also provides a
supporting document
edge property that would cover non-publication source documents (a request from TMKP where not all mined text is from publications).At present these edge properties are not hierarchically related in the Biolink Model.
Questions:
publications
a child ofsupporting document
. And name these properties consistently (e.g. change 'publications' -> 'supporting publications')