create a "how to" README entry for new infores identifiers in the catalog
sierra-moxon opened this issue · comments
<style type="text/css"></style>
Examples of complete wiki pages
Knowledge sources
https://github.com/NCATSTranslator/Translator-All/wiki/ICEES-KG
https://github.com/NCATSTranslator/Translator-All/wiki/CAM-Provider-KG
https://github.com/NCATSTranslator/Translator-All/wiki/DrugBank
https://github.com/NCATSTranslator/Translator-All/wiki/ChEBI
https://github.com/NCATSTranslator/Translator-All/wiki/GO-Annotations
https://github.com/NCATSTranslator/Translator-All/wiki/Food-Ontology
https://github.com/NCATSTranslator/Translator-All/wiki/BindingDB
ARA scoring examples
https://github.com/NCATSTranslator/Translator-All/wiki/BioThings-Explorer-(BTE)
https://github.com/NCATSTranslator/Translator-All/wiki/imProving-Agent
INSTRUCTIONS
- Complete the minimum requirements for wiki pages and check off Column H on tab one (infores-resource) when complete.
Knowledge sources
A valid URL for the original source
A concise user-friendly description of the resource*
A definition of the acronym for the source, defined at first use
An example edge assertion (preferably in natural language) or at least an example record
Licensing and usage information (only if necessary, clinical KPs and DrugBank - assumption is that Translator is completely open)
Additional links (if readily available)
*Note that when revising the descriptions, consider the following guidelines: (1) reword at least a bit to avoid direct copy-and-past from the original source (noting that I'm not concerned about plagiarism, given that we cite the original source); (2) add text where needed to better inform the user; (3) add "open" or "open-source" when that is clearly stated on the original source; and (4) attribute owners (e.g., Broad Institute), which will help build user trust.
ARAs (scoring)
A short, user-friendly description of the scoring algorithm/model used to calculate the ARA scores
Disambiguation of the team from the ARA
- Cross-check against the infores catalog (https://github.com/biolink/biolink-model/blob/master/infores_catalog.yaml) and add a checkmark to column I and a comment to column N if any changes that need to be made to the catalog.
- Note that any changes to the infores catalog will need to be reflected in your resource.
Examples of complete wiki pages
Knowledge sources
https://github.com/NCATSTranslator/Translator-All/wiki/ICEES-KG
https://github.com/NCATSTranslator/Translator-All/wiki/CAM-Provider-KG
https://github.com/NCATSTranslator/Translator-All/wiki/DrugBank
https://github.com/NCATSTranslator/Translator-All/wiki/ChEBI
https://github.com/NCATSTranslator/Translator-All/wiki/GO-Annotations
https://github.com/NCATSTranslator/Translator-All/wiki/Food-Ontology
https://github.com/NCATSTranslator/Translator-All/wiki/BindingDB
ARA scoring examples
https://github.com/NCATSTranslator/Translator-All/wiki/BioThings-Explorer-(BTE)
https://github.com/NCATSTranslator/Translator-All/wiki/imProving-Agent
INSTRUCTIONS
- Complete the minimum requirements for wiki pages and check off Column H on tab one (infores-resource) when complete.
Knowledge sources
A valid URL for the original source
A concise user-friendly description of the resource*
A definition of the acronym for the source, defined at first use
An example edge assertion (preferably in natural language) or at least an example record
Licensing and usage information (only if necessary, clinical KPs and DrugBank - assumption is that Translator is completely open)
Additional links (if readily available)
*Note that when revising the descriptions, consider the following guidelines: (1) reword at least a bit to avoid direct copy-and-past from the original source (noting that I'm not concerned about plagiarism, given that we cite the original source); (2) add text where needed to better inform the user; (3) add "open" or "open-source" when that is clearly stated on the original source; and (4) attribute owners (e.g., Broad Institute), which will help build user trust.
ARAs (scoring)
A short, user-friendly description of the scoring algorithm/model used to calculate the ARA scores
Disambiguation of the team from the ARA
-
Cross-check against the infores catalog (https://github.com/biolink/biolink-model/blob/master/infores_catalog.yaml) and add a checkmark to column I and a comment to column N if any changes that need to be made to the catalog.
-
Note that any changes to the infores catalog will need to be reflected in your resource.