hetio / hetionet

Hetionet: an integrative network of disease
https://neo4j.het.io
257 stars 68 forks source link

Add json definitions file #16

Closed vincerubinetti closed 5 years ago

vincerubinetti commented 5 years ago

Refs https://github.com/greenelab/hetmech-frontend/issues/16

Add .json file to contain definitions for metanodes, metaedges, and fields/properties. Primarily to be used for tooltip text.

dhimmel commented 5 years ago

One question is how we should encode metaedges. One option is abbreviations. Another is the metaedge tuple ids at:

https://github.com/hetio/hetionet/blob/b7c144da0dd428def9e3c262d0bc48c050cf631d/hetnet/json/hetionet-v1.0-metagraph.json#L15-L160

Lookup is potentially more complex than the metanode case because both orientations must be checked.

vincerubinetti commented 5 years ago

So does that mean there are definitions of the metaedges that are dependent on the metanodes that the edge is connecting? Is there no generic way to define "participates" or "upregulates" for example without knowing whether it's a gene, disease, etc.

I thought it would just be:

...
"upregulates": "the process of increasing the response to a stimulus specifically",
...

Using the tuple ids seems better if necessary.

dhimmel commented 5 years ago

So does that mean there are definitions of the metaedges that are dependent on the metanodes that the edge is connecting?

Yes. In reality, the identify of the metaedge depends on the metanodes it connects. Therefore the definitions should be different. See metaedge-styles.tsv for possible styling. We also have disambiguated relationship types we use for Neo4j.

dhimmel commented 5 years ago

We'll have to read over https://github.com/hetio/hetionet/pull/16/commits/eacfd9b0f46881be9745d3e5f9d42ee0cad377a8 to spot any errors.

vincerubinetti commented 5 years ago

Maybe let's try to make the sentences for metanodes consistent with the "from"? Like:

Protein-coding human genes. From Entrez Gene.

or

Complex diseases, selected to be distinct and specific enough to be clinically relevant yet general enough to be well annotated. From Disease Ontology.

or

Anatomical structures, excluding structures that are known not to be found in humans. From Uberon

And maybe we put " quotes around the sources to indicate that they're a source?

dhimmel commented 5 years ago

And maybe we put " quotes around the sources to indicate that they're a source?

I think this would be a bit odd and perhaps unnecessary.

Maybe let's try to make the sentences for metanodes consistent with the "from"? Like:

I've updated the metanode descriptions to conclude with from/From for consistency.

vincerubinetti commented 5 years ago

Looks good to me. Ready to merge.