JAL-1264 unneeded setup removed
[jalview.git] / doc / JalviewRNASupport.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
4  * Copyright (C) 2014 The Jalview Authors
5  * 
6  * This file is part of Jalview.
7  * 
8  * Jalview is free software: you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License 
10  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
18  * The Jalview Authors are detailed in the 'AUTHORS' file.
19 -->
20 <title>Jalview RNA Support</title>
21 <body>
22 <h1>
23 Jalview RNA Support
24 </h1>
25 <p>
26 Jalview RNA support was first added during a 
27 <a href="http://socghop.appspot.com/gsoc/program/home/google/gsoc2010">2010 Google Summer of Code Project</a> by  
28 Lauren Lui (see her <a href="https://www.nescent.org/wg_phyloinformatics/PhyloSoC:Extending_Jalview_to_Support_RNA_Alignment_Annotation_and_Secondary_Structure_Visualization">
29 NESCent wiki page</a> and the project <a href="http://jalview-rnasupport.blogspot.com/">blog</a>).  
30 </p>
31 <h2>What was added</h2>
32 <p>
33 <ul>
34 <li>Recognition of ".stk" and ".sto" extensions for Stockholm file format.</li>
35 <li>Purine/Pyrimidine colour scheme.</li>
36 <li>Colouring by RNA helices. Helices are determined from the secondary structure line written in WUSS format in Stockholm files.</li>
37 <li>Ability to fetch sequences from RFAM.</li>
38 <li>Visualization of RNA secondary structure in WUSS format (from input file) and RNA helices in the 
39 annotation panel.</li>
40 </ul>
41 </p>
42 <p>In 2011, Jan Engelhardt was supported by <a href="http://socghop.appspot.com/gsoc/program/home/google/gsoc2011">GSOC</a> to extend Lauren's work, with <a href="https://www.nescent.org/wg_phyloinformatics/PhyloSoC:_Extending_Jalview_support_for_handling_RNA">support for viewing secondary structure in VARNA and visualizing base pair contact conservation</a>.
43 </p>
44 <h2>What Jan added</h2>
45 <p>
46 <ul>
47 <li>Enable RNA secondary structure annotation to be imported/exported through Jalview annotation files</li>
48 <li>Incorporated <a href="varna.lri.fr">VARNA</a> into the desktop application</li>
49 <li>Added a new base pair consensus histogram and sequence logo annotation row</li> 
50 </ul>  
51 </p>
52 <h2>TODO</h2>
53 <h3>Secondary Structure Visualization/Annotation</h3>
54 <ul>
55 <li>Detection of pseudoknots and tetraloops </li>
56 <li>Update colouring of RNA helices in annotation panel when "By RNA helices" colouring is selected</li>
57 <li>Editing of secondary structure line</li>
58 <li>Update helix colouring when secondary structure changes.</li>
59 <li>Support per sequence in RNA secondary structure annotation</li>
60 </ul>
61
62 <h3>Colour schemes</h3>
63 <ul>
64 <li>Coloring scheme for pseudoknots</li>
65 <li>Covariation colour scheme similar to RFAM's</li>
66 <li>Coloring schemes from other MSA viewers, like 4Sale and Assemble</li>
67 <li>Highlight positions in alignments that break base pairing specified in the secondary structure line</li>
68 </ul>
69 <h3>Embed VARNA, An RNA Secondary Structure Viewer</h3>
70 <ul>
71 <li>The homepage for VARNA can be found <a href="http://varna.lri.fr/">here</a>.</li>
72 <li>Hook VARNA into Jalview</li>
73 <li>Ability to port RNA secondary structure (e.g. from Stockholm files) into VARNA</li>
74 <li>Mouse over and selections get highlighted in the linked views</li>
75 </ul>
76 <h3>Miscellaneous</h3>
77 <ul>
78 <li>Add changes done to the main gui to the applet gui</li>
79 <li>Add export of Stockholm file format</li>
80 </ul>
81 </p> 
82 </body>
83 </html>
84