From: James Procter Date: Thu, 21 Sep 2023 16:27:46 +0000 (+0100) Subject: JAL-4090 what’s new and additional help docs for JAL-3858 JAL-3855 X-Git-Tag: Release_2_11_4_0~169 X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=d9a67bd0b33d00908c3b5a3771742f681673dd08;p=jalview.git JAL-4090 what’s new and additional help docs for JAL-3858 JAL-3855 --- diff --git a/help/help/help.jhm b/help/help/help.jhm index a2094f7..5fb7901 100755 --- a/help/help/help.jhm +++ b/help/help/help.jhm @@ -161,7 +161,10 @@ + + + diff --git a/help/help/helpTOC.xml b/help/help/helpTOC.xml index d7ff3d4..6d7c948 100755 --- a/help/help/helpTOC.xml +++ b/help/help/helpTOC.xml @@ -23,13 +23,10 @@ - - - - - - - + + + + diff --git a/help/markdown/whatsnew/whatsnew-2_11_3_0.md b/help/markdown/whatsnew/whatsnew-2_11_3_0.md index ec82f83f..dbafc08 100644 --- a/help/markdown/whatsnew/whatsnew-2_11_3_0.md +++ b/help/markdown/whatsnew/whatsnew-2_11_3_0.md @@ -1,7 +1,24 @@ -The 2.11.3 series includes support for in-depth exploration of predicted alignment error matrices from AlphaFold in the context of multiple alignments, along with support for standard colourschemes for shading models according to their pLDDT. +The 2.11.3 Jalview release features a new and more powerful command line interface, support for in-depth exploration of predicted alignment error (PAE) matrices from AlphaFold in the context of multiple alignments, AlphaFold's standard Blue-Orange-Red confidence colourscheme, and a host of minor improvements and bug fixes. -We're launching this release at ISMB 2023 - come find us ! +**Interactive exploration of AlphaFold Predicted Alignment Error Matrices** -It also introduces new support for native ARM-based OSX architectures, and a few other goodies! +Predicted alignment error (PAE) matrices are JSON files produced by AlphaFold and other 3D structure prediction tools, which reflect how well any two positions in a predicted structure are positioned correctly relative to each other. Jalview automatically imports PAE matrices when retrieving protein structures from the EBI-AlphaFold database. A PAE matrix file can also be provided when manually importing 3D structure data. +Once imported, PAE matrices are shown in annotation tracks as a heat map shaded pale to dark green, where darker shades indicate higher confidence in relative positioning. Right-clicking a PAE Matrix's annotation label provides the option to cluster the columns of the matrix, producing a tree where regions of well arranged structure are grouped together, allowing columns containing those regions to be selected and manipulated further. + +**Jalview's Next Generation Command Line Interface** + +Jalview 2's original command line interface (CLI) allowed alignments to be imported, annotated and overlaid with sequence features, coloured, associated with trees, and exported either as figures (EPS, PNG, SVG, HTML SVG or an interactive BioJS page) or with one of Jalview's supported alignment export file formats. The new command line interface provides all this, as well as a range of additional functionality previously only available via the GUI: + + * 3D structures can be associated with sequences in alignments and shown in Jmol or external viewers + * Secondary structure, Model Reliability and Temperature factor can be shown and used to colour alignments + * PAE Matrices can be imported and shown as annotation + * 3D structure data shown in Jmol can be exported as PNG + * Scale factors and dimensions can be specified, allowing high resolution image exports + +In addition to these new functionality, next generation CLI operations can be applied to a range of files and directories through the use of wild-cards. This allows faster and more efficient processing of large numbers of alignments. It also facilitates modularisation of operations through the use of ['command-line argument files'](../features/clarguments-argfiles.html). + +All new CLI parameters are preceded by '--', as opposed to an optional single '-' which was used in Jalview's old CLI. Old style arguments can still be used, so existing scripts will still work as before, but old-style operations cannot be mixed with new operations in the same CLI call. Use of old command line operations will also raise a warning, and we plan to completely remove support in Jalview's next major release (2.12). + +As usual, please let us via [Jalview's Discussion forum](https://discourse.jalview.org) of any issues you encounter using the new CLI, and of course any requests for improvement or new functionality !