JAL-4090 tweak pae doc
[jalview.git] / help / help / html / features / paematrices.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>Working with PAE Matrices in Jalview</title>
24 </head>
25
26 <body>
27         <p>
28                 <strong>Working with Predicted Alignment Error Matrices in
29                         Jalview</strong>
30         </p>
31
32         <p>Predicted Alignment Error (PAE) matrices are produced by
33                 deep-learning based 3D-structure prediction pipelines such as
34                 AlphaFold. They reflect how reliably two parts of a model have been
35                 positioned in space, by giving for each residue the likely error (in
36                 &Aring;ngstroms) between that residue and every other modelled
37                 position the pair of residues' real relative position, if the model
38                 and real 3D structure were superimposed at that residue.</p>
39         <p>
40                 Jalview visualises PAE matrices as an alignment annotation track,
41                 shaded from dark green to white, similar to the encoding used on the
42                 EBI-AlphaFold website (see <a
43                         href="https://alphafold.ebi.ac.uk/entry/O04090">O04090 3D model</a>
44                 at EBI-AlphaFoldDB).
45         </p>
46         <div style="display:flex; flex-wrap:wrap;"align="center" width="100%">
47         <figure><img src="../structures/epas1_annotdetail.png" height="300"/><figcaption>Alignment of EPAS1 homologs from Human, Rat and Cow<br/>with predicted alignment error tracks</figcaption></figure>
48         <figure><img src="../structures/epas1_pae_ebiaf.png" height="300"/><figcaption>Predicted Alignment Error Matrix<br/>from <a href="https://alphafold.ebi.ac.uk/entry/Q99814">https://alphafold.ebi.ac.uk/entry/Q99814</a></figcaption></figure>
49         </div>
50         <p>
51                 <strong>Importing PAE Matrices</strong>
52         </p>
53         <p>
54                 Jalview retrieves PAE matrices when importing predicted 3D structures
55                 from the EBI-AlphaFold database via <a
56                         href="../features/structurechooser.html">Jalview's structure
57                         chooser</a> GUI. If you have produced your own models and accompanying
58                 PAE matrices using a pipeline such as ColabFold, then you can load
59                 them both together via the <a
60                         href="../features/structurechooser.html#loadpdbfile">Load PDB
61                         File</a> dropdown menu in the 3D structure chooser. in a <a
62                         href="../io/paematrixformat.html">supported PAE format</a>.
63         </p>
64         <p>
65                 The <a href="../features/clarguments-basic.html">Command Line
66                         Interface</a> also provides a options for importing PAE matrices along
67                 side models, enabling the automated production of alignment figures
68                 annotated with PAE matrices and PLDDT scores.
69         </p>
70         <p>
71                 <strong>Showing PAE Matrix Annotations </strong>
72         </p>
73         <p>
74                 When viewing 3D structures from the EBI-AlphaFold database or local 3D
75                 structures with an associated PAE file, the PAE is imported as <i>Reference
76                         Annotation</i>, which is not always automatically added to the alignment
77                 view.
78         </p>
79         <p>To show the PAE, right click the sequence and locate the 'Add
80                 Reference Annotation' entry in the Sequence ID submenu, or select all
81                 sequences and locate the option in the Selection submenu. You can do
82                 this in any alignment window (or view) where a sequence with
83           associated PAE data appears.</p>
84         <p><strong>Adjusting the height of PAE matrix annotations</strong></p>
85           <p>PAE annotations behave in the same way as Jalview's line graph and histogram tracks. Click+dragging up and down with the left (select) mouse button held down will increase or decrease the height of the annotation. You can also hold down <strong><em>SHIFT</em></strong> whilst doing this to adjust the height of all PAE rows at once. 
86           </p>
87         <p>
88           PAE matrix annotation rows behave like any other sequence associated annotation, with the following additional features:
89         </p>
90         <ul>
91           <li>The vertical axis of the PAE heatmap is mapped to positions on the linked 3D structure.
92             <ul><li>Moving the mouse over any part of the heatmap highlights the corresponding regions of the 3D structure the PAE data is associated with, in addition to a tooltip being displayed giving information on the range of values under the mouse.</li>
93               <li>Clicking to select positions in the matrix results in columns of the alignment corresponding to the row and columns selected in the matrix.</li>
94         </ul>
95         <p></p>
96             <p><strong><a name="clustering">Clustering PAE Matrices</a></strong></p>
97             <p>
98               
99         </p>
100         <p>
101                 <em>Support for visualision and analysis of predicted alignment
102                         error matrices was added in Jalview 2.11.3. </em>
103         </p>
104 </body>
105 </html>