Monarch PhenoGrid widget
npm install phenogrid
Phenogrid is a Javascript component that visualizes semantic similarity calculations provided by OWLSim, as provided through APIs from the Monarch Initiative.
Given an input list of phenotypes (you will see the sample input below) and parameters specified in config/phenogrid_config.js indicating desired source of matching models (humans, model organisms, etc.), the phenogrid will call the Monarch API to get OWLSim results and render them in your web browser in data visualization. And you may use the visualized data for your research.
Phenogrid is published as a npm package, so you will need to have npm (npm is bundled and installed automatically with node.js) installed before you can install Phenogrid.
If you have not installed node.js, try:
``
curl -sL https://rpm.nodesource.com/setup | bash -
yum install -y nodejs
`
This above commands work on RedHat and CentOS.
For OS X machines, you can try these instructions: http://blog.teamtreehouse.com/install-node-js-npm-mac. Or, just visit nodejs.org.
If you are running Ubuntu, you can
``
sudo apt-get install nodejs
sudo apt-get install npm
Then create a symbolic link for "node" as many Node.js tools use this name to execute.
``
sudo ln -s /usr/bin/nodejs /usr/bin/node
To download and install the phenogrid widget, simply run
`
npm install phenogrid
Sometimes, it requires root access to for the installation, just run the following instead
`
sudo npm install phenogrid
This will create a local /node_modules folder in your current working directory, and download/install Phenogrid package and all its dependencies (except the devDepencies) into the local /node_modules folder.
In the below sample code, you will see how to use phenogrid as a embeded widget in your HTML. Please note that in order to parse the js file correctly (since it uses D3.js and D3.js requires UTF-8 charset encoding), we suggest you to add the tag in your HTML head.
`html
`
This URL should be pointed to the OWLSim URL server associated with your installation containing the Monarch web services. You have three options:
- Use http://beta.monarchinitiative.org to connect to the development/test web services. This server is less stable than the production server.
- Use https://monarchinitiative.org to connect to the stable, production version of the web services (better uptime)
- If you are running the complete monarch-app, you can point it to http://localhost:8080, or whichever server/port you are using in your local installation.
It is a Javascript object that contains all the target and source data to be rendered in the grid. Please refer to the above example. Basically, it consists of three parts: title, xAxis, and yAxis.
- title - Short description of the data.xAxis
- - An arry of target groups. Each group is a Javascript object that has groupId and groupName (must be unique), both are strings.yAxis
- - An array of phenotypes. Each phenotype is formatted as an object that has id and term, both are strings.
Following is an simple example:
``
{
"title": "Diseases, Mouse and Fish models ",
"xAxis": [
{
"groupId": "9606",
"groupName": "Homo sapiens"
},
{
"groupId": "10090",
"groupName": "Mus musculus"
},
{
"groupId": "7955",
"groupName": "Danio rerio"
}
],
"yAxis": [
{
"id": "HP:0000006",
"term": "Autosomal dominant inheritance"
},
{
"id": "HP:0000174",
"term": "Abnormality of the palate"
},
{
"id": "HP:0011304",
"term": "Broad thumb"
}
]
}
The different ways that the sources (e.g., phenotypes) can be sorted. The sources that are shown on the left side of the grid may be sorted using one of three methods.
- Alphabetical - A-Z
- Frequency and Rarity - sources, e.g., phenotypes are sorted by the sum of the phenotype values across all models/genes
- Frequency - Default, sources, e.g., phenotypes are sorted by the count of the number of model/gene matches per phenotype
For each pairwise comparison of phenotypes from the query (q) and target (t), we can assess their individual similarities in a number of ways.
- 0 - Similarity
- 1 - Ratio (q)
- 2 - Uniqueness
- 3 - Ratio (t)
Some phenogrid features are not support by IE 11 and below. So please use Google chrome, Fireffox, or Safari to open this widget.
If you would like to poke around Phenogrid and make changes to the source code, you will also need to have all the devDepencies downloaded by running the following code in the Phenogrid package root directory:
``
npm install
Once the installation is finished, you are welcome to make code changes and test them out by running
``
gulp bundle
This command will use browserify to bundle up phenogrid core and its dependencies into phenogrid-bundle.js and create the merged phenogrid-bundle.css and put both files under dist folder. And both bundled files will be minified.
It's helpful to have unminified versions of phenogrid-bundle.js and phenogrid-bundle.css for development and debugging. If this is the case, you can run the following command.
``
gulp dev-bundle
This will also show you all the JSHint messages for debugging or improving the code.
Phenogrid is released under the GPL-2.0 license.