Skip to content

Commit 2fa3df4

Browse files
author
Seren
committed
Some contents added to README
1 parent d73b74e commit 2fa3df4

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed

README

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
G W A S G E N E V I E W E R - 0.2.0
2+
a GWT composite for combined visualization GWAS plots and gene models.
3+
4+
//////////////////////////////////////////////////////////////////////////////
5+
6+
License MIT (see included LICENSE)
7+
Original Author Ümit Seren
8+
9+
10+
Web Site -
11+
Github Repo. https://github.com/timeu/GWASGeneViewer
12+
Bug Tracking -
13+
Test Suite -
14+
15+
16+
//////////////////////////////////////////////////////////////////////////////
17+
18+
ACKNOWLEDGMENT & THIRD PARTY LIBRARIES
19+
20+
- processing.js by John Resig (http://processingjs.org)
21+
- Google Web Toolkit (GWT) by Google (http://code.google.com/webtoolkit/)
22+
- jbrowse by GMOD (http://jbrowse.org)
23+
- dygraphs by Dan Vanderkam (http://dygraphs.com/)
24+
25+
//////////////////////////////////////////////////////////////////////////////
26+
27+
INTRODUCTION
28+
29+
GWASGeneViewer is a simple Google Web Toolkit (GWT) widget for a combined
30+
visualization of Genome Wide Association Mapping (GWAS) plots and gene models.
31+
32+
The widget uses the a modified version of dygraphs's GWT widget and the GeneViewer
33+
widget (see required 3rd party libraries).
34+
The required GeneViewer widget uses processing.js to visualize the gene models
35+
and a modified version of dygraphs is used to visualize the GWAS plots as
36+
scatterplots.
37+
38+
The widget combines these two visualization tools (GeneViewer and Dygraph)
39+
so that the genes are aligned with the GWAS plots and wire interactions in either
40+
of these widgets together.
41+
42+
This means if the user zooms into a region in the GWAS plot the gene model view
43+
will also be zoomed into the same region. This is only one example of interactions
44+
which are supported by this widget (see USAGE for more examples).
45+
46+
47+
48+
//////////////////////////////////////////////////////////////////////////////
49+
50+
PLATFORM AND BROWSER COMPATIBILITY
51+
52+
The GeneViewer widget uses processing.js to visualize the gene models.
53+
The Dygraph widget uses dygraphs.js to visualize the GWAS plots.
54+
Both widgets rely on the HTML5 canvas element. For browser compatiblity refer to
55+
the documentation of both libraries.
56+
57+
In general this widget works with browser that support the HTML5 canvas element.
58+
In case of Microsoft's IE this only applies to the Internet Explorer 9.0
59+
60+
//////////////////////////////////////////////////////////////////////////////
61+
62+
USAGE
63+
64+
to be written
65+
66+
//////////////////////////////////////////////////////////////////////////////

0 commit comments

Comments
 (0)