KP Tool Template

*Click "Edit" (right of the page title) for the fully annotated template.*

Back to Home

KP Tool Template Overview

IMPORTANT: Please see Translator Edge Attributes Template for examples of the minimum information required by the UI team for display to users.

See Documentation Requirements for Translator Tools from 2021 Program Milestones from 2021 Program Milestones for more information.

Below are minimum requirements for documentation of Translator tools and components. Please create a KP tool page using the template structure below. If there are additional details that could be provided about the tool please include them in your KP tool page. Note, each tool must have its own wiki page that is linked to the KP team page.

Note on shared tools: Tools shared and maintained by multiple teams, please list the teams that support/maintain these tools. e.g. Tool X is provided by Service Provider and Ranking Agent. (See the description section below)

Each software component has a standard, permissive software license and is documented in the corresponding GitHub repository. Examples include BSD 3-clause and MIT. APIs, KPs, ARAs, and ARS adhere to the Biolink Model. KPs, ARAs, and ARS adhere to the community ratified APIs and other standards (such as the ReasonerStdAPI), where applicable. APIs, KPs, ARAs, and ARS adhere to a standard of versioning, deprecation, and documentation such that the Translator community understands what has changed and the impact of those changes.

KP Tool Template

Back to Home

XXX Provider Tool Description - (include a few sentences describing your tool, a high level explanation what is this tool used for, link to modes of access which will give the metadata about the resource, and a how-to guide for the tools.) See example below.

TIARA is KP created/supported/maintained by a XXX Provider. Click here to view the XXX Provider page. TIARA is a 3-tiered crown worn by the pope, a decorative jeweled or flowered headband or semicircle for formal wear by women.

• Technical User Guide to TIARA - (instructions should allow a reasonably-competent user to make a test query using a specific example, retrieve the results, then create their own query, with tips and common errors described – similar to https://github.com/NCATSTranslator/Relay/wiki/ARS-Query-Process)
• Modes of Access (provide a link) - Reasoner API v.#.#.#, SmartAPI registry, KGX - formatted Knowledge Graph
  • Link
  • Link
  • Link
• Guide for user on how to open an issue and find current issues to avoid duplicate issues
• How to build your own instance for NCATS Deployment pipeline

Use Cases- (Several use cases and detailed curl commands to retrieve the results using the most current Translator standards (eg: TRAPI, biolink, Architecture Principles) (with any that are NOT using these standards marked as such) Please store these use cases in the NCATS Translator Testing Repo and provide a link to the use cases in this wiki page.)

• Link
• Link

Knowledge Sources Accessed - (List the knowledge sources that your tools ingest). See example below.

• BigGIM and BigCLAM
• Columbia Open Health Data

Source Code - (include links to your source code). See example below

• Jupyter notebook
• Code file

External Documentation (List of urls for documentation sites). See example below.

• https://www.imdb.com/title/tt0484244/