Merge branch 'develop' into releases/Release_2_11_3_Branch
authorJames Procter <j.procter@dundee.ac.uk>
Wed, 15 Nov 2023 16:09:03 +0000 (16:09 +0000)
committerJames Procter <j.procter@dundee.ac.uk>
Wed, 15 Nov 2023 16:09:03 +0000 (16:09 +0000)
help/help/html/features/paematrices.html
help/markdown/releases/release-2_11_3_0.md
src/jalview/gui/IdCanvas.java

index 2f00e19..8857894 100644 (file)
                        Jalview</strong>
        </p>
 
-       <p>Predicted Alignment Error (PAE) matrices are produced by
-               deep-learning based 3D-structure prediction pipelines such as
-               AlphaFold. They reflect how reliably two parts of a model have been
-               positioned in space, by giving for each residue the likely error (in
-               &Aring;ngstroms) between that residue and every other modelled
-               position the pair of residues' real relative position, if the model
-               and real 3D structure were superimposed at that residue.</p>
+  <p>Predicted Alignment Error (PAE) matrices are produced by
+    deep-learning based 3D-structure prediction pipelines such as
+    AlphaFold. They reflect how reliably two parts of a model have been
+    positioned in space. Each column in a PAE matrix corresponds to a 
+    residue in the model, and each gives the likely RMS error (in
+    &Aring;ngstroms) between that residue and every other modelled
+    position the pair of residues' real relative position, if the model
+    and real 3D structure were superimposed at that residue.</p>
        <p>
                Jalview visualises PAE matrices as an alignment annotation track,
                shaded from dark green to white, similar to the encoding used on the
                        href="https://alphafold.ebi.ac.uk/entry/O04090">O04090 3D model</a>
                at EBI-AlphaFoldDB).
        </p>
-       <div style="display: flex; flex-wrap: wrap;" align="center"
-               width="100%">
+  <img src="../structures/epas1_annotdetail.png" width="450" />
+  <br/><em>
+                               Alignment of EPAS1 homologs from Human, Rat and Cow shaded by PLDDT, with
+                               Predicted Alignment Error and secondary structure annotation shown for Human.
+                               </em>
+       <!--</div>  
+  <div width="35%">
                <figure>
-                       <img src="../structures/epas1_annotdetail.png" height="300" />
-                       <figcaption>
-                               Alignment of EPAS1 homologs from Human, Rat and Cow<br />with
-                               predicted alignment error shown for Human
-                       </figcaption>
-               </figure>
-               <figure>
-                       <img src="../structures/epas1_pae_ebiaf.png" height="300" />
+                       <img src="../structures/epas1_pae_ebiaf.png" />
                        <figcaption>
                                Predicted Alignment Error for Human EPAS1<br />from <a
                                        href="https://alphafold.ebi.ac.uk/entry/Q99814">https://alphafold.ebi.ac.uk/entry/Q99814</a>
                        </figcaption>
                </figure>
-       </div>
+               </div>
+       </div> -->
        <p>
                <strong>Importing PAE Matrices</strong>
        </p>
@@ -76,9 +76,9 @@
        </p>
        <p>
                The <a href="../features/clarguments-basic.html">Command Line
-                       Interface</a> also provides a options for importing PAE matrices along
-               side models, enabling the automated production of alignment figures
-               annotated with PAE matrices and PLDDT scores.
+                       Interface</a> also provides the option to import a PAE matrix alongside
+                       a 3D structure file, enabling the automated production of alignment figures
+                 annotated with PAE matrices and PLDDT scores.
        </p>
        <p>
                <strong>Showing PAE Matrix Annotations </strong>
@@ -86,7 +86,7 @@
        <p>
                When viewing 3D structures from the EBI-AlphaFold database or local 3D
                structures with an associated PAE file, the PAE is imported as <i>Reference
-                       Annotation</i>, which is not always automatically added to the alignment
+                       Annotation</i>, and is not always automatically added to the alignment
                view.
        </p>
        <p>To show the PAE, right click the sequence and locate the 'Add
                PAE often correlate with high alphafold reliability (PLDDT) scores,
                but also complement them since they highlight well-folded regions such
                as domains, and how well those regions have been predicted to be
-               positioned relative to eachother, which is important when evaluating
+               positioned relative to each other, which is important when evaluating
                whether domain-domain interactions or other contacts can be trusted.</p>
-       <p>To make it more easy to identify regions of low PAE, Jalview can
+       <p>To make it easy to identify regions of low PAE, Jalview can
                cluster the PAE matrix, allowing columns of the matrix to be grouped
                according to their similarity, using an Average Distance (UPGMA) tree
                algorithm and the sum of differences between each column's PAE values.</p>
                        &#8741;</strong>
        </p>
        <p>
-               To create a PAE matrix tree, right click on a PAE annotation's label
+               <em>Creating a PAE matrix tree</em><br/>Right click on a PAE annotation's label
                to open the annotation popup menu, and select <strong><em>Cluster
                                Matrix</em></strong>. Once the calculation has finished, a tree viewer will open,
                and columns of the matrix are then partitioned into groups such that
                the third left-most node from the root is placed in its own group.
-               Colours are randomly assigned to each group, and by default these will
-               also be overlaid on the matrix annotation row.
+               Colours are randomly assigned to each group. By default column group colours will
+               also be overlaid on the matrix annotation row - this can be turned off 
+               via the PAE annotation row menu (by unticking <em>Show groups on matrix</em>).</p>
        <p>
+  The PAE matrix tree viewer behaves like other tree views, except:  
        <ul>
-               <li>The PAE matrix tree viewer behaves like other tree views in
-                       Jalview, except selecting nodes or groups of nodes in the tree select
-                       columns in the alignment rather than sequences, and clicking adjust
+               <li>Selecting nodes or groups of nodes in the tree select
+                       columns in the alignment, and clicking in the tree window adjust
                        the matrix's partition.</li>
                <li>Only one tree and clustering can be defined for a PAE matrix,
                        regardless of whether it is displayed in different views or
                        alignments.</li>
-               <li>Double clicking on a position in the PAE annotation where a
+       </ul>
+       Once the PAE annotation has clustering defined:
+       <ul><li>Double clicking on a position in the PAE annotation where a
                        clustering has been defined will select both the row and column
-                       clusters for the clicked position. This makes it easy to select
+                       clusters for the clicked position. <br/><br/>This makes it easy to select
                        clusters corresponding to pairs of interacting regions.</li>
                <li>Cluster colours for a PAE matrix can be used to colour
                        sequences or columns of the alignment via the <strong><em><a
index 821f418..47b3778 100644 (file)
@@ -1,6 +1,6 @@
 ---
 version: 2.11.3.0
-date: 2023-11-14
+date: 2023-11-15
 channel: "release"
 ---
 
@@ -78,6 +78,7 @@ channel: "release"
 - <!-- JAL-4110 --> Output stderr and stdout when running tests via gradle
 - <!-- JAL-3599 --> New gradle task providing runtime acceptance test for JalviewJS  based on Chromium for Tests (still work in progress)
 
+
 ## Issues Resolved
 - <!-- JAL-2961 --> Jmol view not always centred on structures when multiple structures are viewed
 - <!-- JAL-3772 --> Unsaved Alignment windows close without prompting to save, individually or at application quit.
@@ -110,12 +111,14 @@ channel: "release"
 - <!-- JAL-4218 --> Jalview source distribution unnecessarily includes dist directory with built jalview jar and dependencies
 - <!-- JAL-3921 --> Jmol sessions involving large molecules may not be fully saved in Jalview project files (known defect in 2.11.2.x)
 
-## New Known defects
+
+### New Known Issues
 - <!-- JAL-4303 --> EBI-AlphaFold PLDDT colours cannot be overlaid on alignment via 'Colour by annotation' unless the alignment's colourscheme has been set to 'None' via the Colours menu.
 - <!-- JAL-4302 --> Tree renderer doesn't show bottom-most leaves of tree when Fit-To-Window is enabled.
+- <!-- JAL-4338 --> PAE partition not shown in the same place when tree is closed and reopened
 - <!-- JAL-4178 --> Cannot cancel structure view open action once it has been started via the structure chooser dialog
 - <!-- JAL-4142 --> Example project's multiple views do not open in distinct locations when eXpand views is used to show them all separately
-- <!-- JAL-4127 --> 'Reload' for a jalview project results in all windows being duplicated (since 2.11.2.6, more severe in 2.11.3.0
+- <!-- JAL-4127 --> 'Reload' for a jalview project results in all windows being duplicated (since 2.11.2.6, more severe in 2.11.3.0)
 - <!-- JAL-4325 --> Overview shown and then closed when importing legacy jalview projects without overview store/restore information
 - <!-- JAL-4165 --> Missing last letter when copying consensus sequence from alignment if first column is hidden
 - <!-- JAL-4261 --> Last sequence ID in alignment not shown and annotation labels are misaligned in HTML export
@@ -123,7 +126,7 @@ channel: "release"
 - <!-- JAL-4291 --> Test coverage for ID width adjustment disabled pending fix for new annotation label geometry and width calculation
 - <!-- JAL-4323 --> scripts adding new fileformats or colourschemes do not work when run via command line
 - <!-- JAL-4290 --> Headless alignment export with structure annotations doesn't include secondary structure and temperature factor
-- <!-- JAL-4151 --> Copy sequences from one alignment and Pasting as new window in another alignment doesn't propagate title from original alignment's window)
+- <!-- JAL-4151 --> Copy sequences from one alignment and Pasting as new window in another alignment doesn't propagate title from original alignment's window
 - <!-- JAL-4157 --> Annotation colouring dialog box doesn't remember 'use original colours' settings when opened via the Colour menu
 - <!-- JAL-4327 --> When the Groovy console is open Jalview does not prompt to save before quitting  
 - <!-- JAL-4328 --> Jalview works with but is not fully compatible with latest Ensembl REST API (15.6)
index 3ee3316..76020c7 100755 (executable)
@@ -398,13 +398,13 @@ public class IdCanvas extends JPanel implements ViewportListenerI
    * 
    * @param g
    * @param av2
-   * @param i
+   * @param startSeq
    * @param totalHeight
    */
-  public void drawIdsWrappedNoGUI(Graphics2D g, AlignViewport av2, int i,
-          int totalHeight)
+  public void drawIdsWrappedNoGUI(Graphics2D g, AlignViewport av2,
+          int startSeq, int totalHeight)
   {
-    drawIdsWrapped(g, av2, totalHeight, totalHeight, i, false);
+    drawIdsWrapped(g, av2, startSeq, totalHeight, -1, false);
   }
 
   public void drawIdsWrapped(Graphics2D g, AlignViewport alignViewport,