Skip to content

Commit a879140

Browse files
authored
Merge pull request #343 from Sage-Bionetworks/allaway-patch-1
add drug terms best practices to contributing doc
2 parents 84a28ff + 1c197f7 commit a879140

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,42 @@ If you are proposing a new term, then we require a source for the definition. Th
1616
1. If you are a Sage Bionetworks employee and cannot find a source URL, then use "Sage Bionetworks" as the `source` and your own definition.
1717
2. If you are not (nor are you working with a Sage Bionetworks supported community) it is up to you for a strategy for controlling new terms to be added.
1818

19+
## Guidelines for specific term types
20+
21+
In some situations (e.g. drug names), terms are not always well-captured by the ontologies found in the Ontology Lookup Service. We've defined some best practices for contributing these terms here.
22+
23+
### Contribution of drug terms
24+
25+
The preferred first-pass strategy for chemical name annotation is to search the EMBL-EBI ontology lookup service to find names, descriptions, and sources. Typically, the NCI Thesaurus will provide a suitable description for drugs and other biologically active molecules. In situations where the query molecule is not found in [EMBL-EBI Ontology Lookup Service](https://www.ebi.ac.uk/ols), a helpful secondary location to find chemical descriptions is [MeSH](https://meshb.nlm.nih.gov/).
26+
27+
Example:
28+
29+
```
30+
{
31+
"value": "DEFACTINIB",
32+
"description": "An orally bioavailable, small-molecule focal adhesion kinase (FAK) inhibitor with potential antiangiogenic and antineoplastic activities.",
33+
"source": "http://purl.obolibrary.org/obo/NCIT_C79809"
34+
},
35+
```
36+
37+
In situations where novel molecules (such as newly-synthesized research compounds or proprietary pharmaceutical molecules) require annotation, the only suitable description and source might be the paper describing the synthesis or discovery, or information from the pharmaceutical company that created the identifier.
38+
39+
Example:
40+
41+
```
42+
{
43+
"value": "IPC-12345",
44+
"description": "An small-molecule target of importance 4 (TOI4) inhibitor with potential antineoplastic activities.",
45+
"source": "Important Pharma Company"
46+
},
47+
{
48+
"value": "BestChemist-00913",
49+
"description": "An investigational small molecule discovered by Best Chemist et al.",
50+
"source": "PubMed Link Goes Here"
51+
},
52+
```
53+
54+
1955
## Contribution procedure
2056

2157
Again, this is focused on Sage Bionetworks supported communities and employees. This focuses on the logistical components to contributing - for the technical components, please see the [Development](https://github.com/Sage-Bionetworks/synapseAnnotations#development) section of the [README.md](README.md) document.

0 commit comments

Comments
 (0)