TGAC/aequatus.js

Name: aequatus.js

Owner: Earlham Institute

Description: Visualisation JavaScript library for Homologous Genes

Forked from: anilthanki/aequatus.js

Created: 2015-11-23 13:31:02.0

Updated: 2017-09-28 21:08:29.0

Pushed: 2017-12-06 11:07:25.0

Homepage:

Size: 1856

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

aequatus.js

Visualisation JavaScript library for Homologous Genes

Usage

Aequatus.js is a visualisation JavaScript library for Homologous Genes, easy to integrate with existing web services.

To use aequatus.js in your webservice use following simple snippet.

syntenic_data = json;
(syntenic_data, "#settings_div", "#filter", "#sliderfilter");
Tree(syntenic_data.tree, "#gene_tree", popup);

where settings_div, filter_div and sliderfilter are ids for the divs to hold various controls, filter options and slider; and popup is a callback for JavaScript function when clicked on any gene.

An example popup is included in the demo.

Functions:

geReference(new_gene_id, new_protein_id)

It is used to change reference gene in showing gene families.

Data Format

An Example dataset is provided in the demo/data directory.

snapshot:

ef":<ref gene id>,
rotein_id":<ref protein id>,
ree":<genetree in JSON>
ember":<JSON formatted genes array>

In which genetree and each gene information can be downloaded from Ensembl using REST API.

1. Ensembl REST for genetree: http://rest.ensembl.org/documentation/info/genetree
2. Ensembl REST for gene: http://rest.ensembl.org/documentation/info/lookup

License

aequatus.js is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

aequatus.js is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Aeqautus.js. If not, see http://www.gnu.org/licenses/.

Project contacts:

• Anil Thanki Anil.Thanki@earlham.ac.uk
• Robert Davey Robert.Davey@earlham.ac.uk

© 2015 - 2016. Earlham Institute, Norwich, UK