JAL-1551 spotlessApply
[jalview.git] / help / help / html / features / xsspannotation.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
4  * Copyright (C) $$Year-Rel$$ 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
11  * of the License, or (at your option) any later version.
12  *  
13  * Jalview is distributed in the hope that it will be useful, but 
14  * WITHOUT ANY WARRANTY; without even the implied warranty 
15  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
16  * PURPOSE.  See the GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
20  * The Jalview Authors are detailed in the 'AUTHORS' file.
21  -->
22 <head>
23 <title>Annotation from 3D structure data</title>
24 </head>
25 <body>
26   <p>
27     <strong>Working with annotation from 3D structure data</strong>
28   </p>
29   <p>
30     Jalview can process PDB data associated with sequences to display
31     values extracted from the <em>Temperature Factor</em> column for
32     corresponding sites, and secondary structure from DSSP or RNAView
33     (as appropriate).
34   </p>
35   <p>
36     <strong>Extracting data from PDB files<br /></strong>Annotation is
37     created for structure files retrieved directly from the PDB loaded
38     from the file system (via the <strong>Structure&rarr;Associate
39       Structure...&rarr;From file</strong> option, or when displayed via the View
40     Structures Menu.<br /> Structure annotation is not automatically
41     added to an alignment, but any available structure annotation rows
42     for the current selection or a particular sequence can be added via
43     the <strong>Add Reference Annotation</strong> in the <strong>Selection</strong>
44     and <strong>Sequence ID</strong> sub-menus of the Sequence ID
45     Panel's popup menu.<br /> <em>Please note:</em>Protein structures
46     are analysed <em>in situ</em>, but Jalview employs a web service to
47     process RNA structures which can cause long delays if your internet
48     connection is slow.
49   </p>
50   <p>
51     The <a href="../menus/alwannotation.html"><em>Annotations</em>
52       alignment menu</a> provides settings useful for controlling the
53     display of secondary structure annotation.
54   </p>
55   <p>
56     <strong>Shading sequences by associated structure
57       annotation<br />
58     </strong>The annotation colouring dialog (opened by the <strong>Colour&rarr;By
59       Annotation</strong> option) allows sequences with associated secondary
60     structure data to be shaded according to secondary structure type.
61     Once the dialog is opened, select the <em>Per Sequence</em> option
62     and then choose <em>Secondary structure</em> from the dropdown menu.<br />When
63     colouring alignments by secondary structure, two modes can be
64     employed. The default is to shade sequences with the same colour as
65     the secondary structure glyph. If, however, <em>original
66       colours</em> is selected and another colourscheme has already been
67     applied, then only portions of the sequence with defined secondary
68     structure will be shaded with the previously applied scheme.<br />
69   </p>
70   <p>
71     <strong>Configuration options for processing PDB files<br /></strong>
72     Occasionally, you may wish to disable secondary structure
73     processing. Configuration options in the <strong>Structure</strong>
74     tab in the <strong>Tools&rarr;Preferences</strong> dialog allow the
75     processing of structure data to be disabled, or selectively enabled.
76     For more information, take a look at the <a
77       href="preferences.html#structure">documentation for the
78       structure panel</a>.
79   </p>
80   <p>
81     <em>The display of secondary structure data was introduced in
82       Jalview 2.8.2, and is made possible by Jalview's use of <a
83       href="jmol.html">Jmol's DSSP implementation</a>, based on the
84       original <a href="http://www.ncbi.nlm.nih.gov/pubmed/6667333">Kabsch
85         and Sander algorithm</a> ported by <a
86       href="http://swift.cmbi.ru.nl/gv/dssp/">Robbie P. Joosten
87         and colleagues</a>, and a client for <a
88       href="https://github.com/fjossinet/PyRNA">Fabrice
89         Jossinet's pyRNA services</a> that was developed by Anne Menard, Jim
90       Procter and Yann Ponty as part of the Jalview Summer of Code 2012.
91     </em>
92   </p>
93 </body>
94 </html>