help/help/html/features/preferences.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>Preferences</title>
  24 </head>
  25
  26 <body>
  27   <p>
  28     <strong>Preferences</strong>
  29   </p>
  30   <p>
  31     The preferences panel is opened from the Jalview Desktop&rsquo;s <strong><em>Tools</em></strong>
  32     menu.
  33   </p>
  34   <p>There are eight tabs in the Preferences dialog box:
  35   <ul>
  36     <li>The <a href="#visual"><strong>&quot;Visual&quot;</strong>
  37         Preferences</a> tab allows you to configure the default display for
  38       a new alignment window.
  39     </li>
  40     <li>The <a href="#colours"><strong>&quot;Colours&quot;</strong>
  41         Preferences</a> tab allows you to configure default colourschemes
  42       for a new alignment window.
  43     </li>
  44     <li>The <a href="#overview"><strong>&quot;Overview&quot;</strong>
  45         Preferences</a> tab configures defaults for the overview window.
  46     </li>
  47     <li>The <a href="#structure"><strong>&quot;Structure&quot;</strong>
  48         Preferences</a> tab allows you to configure options for obtaining
  49       and displaying structure information.
  50     </li>
  51     <li>The <a href="#connections"><strong>&quot;Connections&quot;</strong>
  52         Preferences</a> tab allows you to configure Jalview's internet
  53       settings and specify your default web browser.
  54     </li>
  55     <li>The <a href="#links"><strong>&quot;Links&quot;</strong>
  56         Preferences</a> tab shows the currently configured <em>URL
  57         Links</em> shown in the <strong>Link</strong> submenu in the Sequence
  58       ID popup menu.
  59     </li>
  60     <li>The <a href="#output"><strong>&quot;Output&quot;</strong>
  61         Preferences</a> tab contains settings affecting the export of
  62       sequence alignments and EPS files.
  63     </li>
  64     <li>The <a href="#editing"><strong>&quot;Editing&quot;</strong>
  65         Preferences</a> tab contains settings affecting behaviour when editing alignments.
  66     </li>
  67     <li>The <a href="#hmmer"><strong>&quot;HMMER&quot;</strong>
  68         Preferences</a> tab allows you to configure locally installed HMMER tools.
  69     </li>
  70     <li>The <a href="../webServices/webServicesPrefs.html"><strong>&quot;Web
  71           Service&quot;</strong> Preferences</a> tab allows you to configure the <a
  72       href="http://www.compbio.dundee.ac.uk/jabaws">JABAWS</a>
  73       servers that Jalview uses, and change the layout of the
  74       alignment's Web Services menu.
  75     </li>
  76   </ul>
  77   </p>
  78   <p>
  79     <strong><a name="visual">Visual</a> Preferences tab</strong>
  80   </p>
  81   <p>
  82     <em>Maximise Window</em> - If this is selected, a new alignment
  83     window will stretch to fit the available space.
  84   </p>
  85   <p>
  86     <em>Open Overview Window</em> - When this is selected, the <a
  87       href="overview.html">alignment overview</a> panel is opened
  88     by default for a new alignment window.
  89   </p>
  90   <p>
  91     <em>Show Annotations</em> - If this is selected the new window will
  92     display an annotation panel below the sequences. This annotation
  93     panel may have several rows describing the whole alignment. The 4
  94     standard annotations <em>Conservation</em>, <em>Quality</em>,
  95     <em>Occupancy</em> and <em>Consensus</em> for the alignment may
  96     be shown or hidden by default using the checkboxes adjacent and
  97     below.
  98   </p>
  99   <p>
 100     <em>Show group: Conservation and Consensus</em> controls the display
 101     of per-group automatic annotation.
 102   </p>
 103   <p>
 104     <em>Consensus: Histogram and Logo</em> checkboxes control the
 105     display of the consensus histogram and sequence logo for consensus
 106     annotation rows.
 107   </p>
 108   <p>
 109     <em>Full Sequence ID</em> - If selected the ID panel will display
 110     the name of a sequence plus the start and end residues in the format
 111     name/start-end. If not selected, the displayed ID will be the name
 112     of the sequence.
 113   </p>
 114   <p>
 115     <em>Right Align IDs</em> - select to align all sequence IDs to the
 116     left-hand edge of the sequence alignment, rather than the left-hand
 117     edge of the alignment display window.
 118   </p>
 119   <p>
 120     <em>Font</em> - The default font name, size and style can be set for
 121     a new alignment window.
 122   </p>
 123   <p>
 124     <em>Sequence ID Tooltip</em>: Control the display of Database
 125     References and Non-positional annotation in the tooltip displayed
 126     when the mouse is over a sequence's ID.
 127   </p>
 128   <p>
 129     <em>Show Unconserved</em> - When this is selected, all consensus
 130     sequence symbols will be rendered as a '.', highlighting mutations
 131     in highly conserved alignments.
 132   </p>
 133   <p>
 134     <em>Sequence Name Italics</em> - select to apply the italicised
 135     version of the font to sequence labels.
 136   </p>
 137   <p>
 138     <em>Smooth Font</em> - Toggles anti-aliasing on / off for faster
 139     rendering of the alignment.
 140   </p>
 141   <p>
 142     <em>Gap Symbol</em> - The default gap symbol may be set to either
 143     &quot;-&quot; or &quot;.&quot;
 144   </p>
 145   <p>
 146     <em>Wrap Alignment</em> - Select whether to open new alignment
 147     windows in wrapped mode or not.
 148   </p>
 149   <p>
 150     <em>Sort alignment by</em> - When the alignment is loaded in, it can
 151     be ordered as read (No sort), or sorted by Id or pairwise identity.
 152   </p>
 153   <p>
 154     <em>Sort annotations by</em> - Annotations can be unsorted, sorted
 155     by the order of the related sequences in the alignment, or by label.
 156     Autocalculated annotations (e.g. Consensus) can be shown either last
 157     (below sequence annotations) or first (above sequence annotations).
 158     <em>Since Jalview 2.8.2.</em>
 159   </p>
 160   <p>
 161     <em>Open file</em> - If this is selected then the default alignment
 162     file will be opened when Jalview is started. You can change the
 163     default file by clicking on file name and either typing in the file
 164     path or selecting it from the file chooser window.<br /> <em>Note:
 165       The default example alignment is updated periodically to
 166       demonstrate new features in Jalview.</em>
 167   </p>
 168   <p>
 169     <a name="colours"><strong>&quot;Colours&quot;
 170         Preferences tab</strong>
 171   </p>
 172   <p>
 173     <em>Alignment Colour</em> - The default colour scheme for a new
 174     alignment window. If the chosen option is &quot;User Defined&quot;
 175     then the last User Defined Colour loaded or saved via the User
 176     Defined Colours panel will be loaded.
 177   </p>
 178   <p>
 179     <em>Annotation Shading Default</em> - set the default minimum and
 180     maximum colours used when <a
 181       href="../colourSchemes/annotationColouring.html">Colour
 182       by Annotation...</a> is selected from the alignment window's colours
 183     menu.
 184   </p>
 185    <p>
 186     <a name="overview"><strong>&quot;Overview&quot;
 187         Preferences tab</strong>
 188   </p>
 189   <p>
 190     <em>Use legacy gap colouring (gaps are white)</em> - when enabled,
 191     Jalview's overview shows gaps as white, and sequences with no
 192     colourscheme applied as grey.
 193   </p>
 194   <p>
 195     <em>Show Hidden regions when opening overview</em> - default setting
 196     for inclusion of hidden regions.
 197   </p>
 198   <p>
 199     <em>Gap Colour</em> - When legacy gap colouring is not enabled, this
 200     configures the default colour for gaps in the overview.
 201   </p>
 202   <p>
 203     <em>Hidden Colour</em> - colour used to highlight regions in the
 204     overview that are hidden in the alignment.
 205   </p>
 206   <p>
 207     <a name="structure"><strong>&quot;Structure&quot;
 208         Preferences tab</strong></a><em> added in Jalview 2.8.2</em>
 209   </p>
 210   <p>
 211     <em>Process secondary structure from PDB</em> - if selected, then
 212     structure information read from PDB will be processed and annotation
 213     added to associated sequences.
 214   <p>
 215     <em>Use RNAView for secondary structure</em> - if selected, the
 216     pyRNA RNAView service (<a href="https://github.com/fjossinet/PyRNA">https://github.com/fjossinet/PyRNA</a>)
 217     will be called to derive secondary structure information for RNA
 218     chains.
 219   <p>
 220     <em>Add secondary structure annotation to alignment</em> - if
 221     selected, <a href="http://swift.cmbi.ru.nl/gv/dssp/">Jmol's
 222       implementation DSSP</a> will be used to add annotation to polypeptide
 223     chains in the structure.
 224   <p>
 225     <em>Add Temperature Factor annotation to alignment</em> - if
 226     selected, values extracted from the Temperature Factor column for
 227     the backbone atoms in the PDB file will be extracted as annotation
 228     lines shown on the alignment.
 229   <p>
 230     <em>Default structure viewer</em> - choose Jmol or CHIMERA for
 231     viewing 3D structures.
 232   <p>
 233     <em>Path to Chimera program</em> - Optional, as Jalview will search
 234     standard installation paths for Windows, Linux or MacOS. If you have
 235     installed Chimera in a non-standard location, you can specify it
 236     here, by entering the full path to the Chimera executable program.
 237     Double-click this field to open a file chooser dialog.
 238   <p>
 239   <p>
 240     <em>PDB Fields shown in Search and Structure Summaries</em> - ticks
 241     in this table indicate fields shown by default when browsing results
 242     of a free text search via the PDB sequence fetcher, or 3D structures
 243     offered by the 3D Structure Chooser.<p>
 244   <p>
 245     <a name="connections"><strong>&quot;Connections&quot;
 246         Preferences tab</strong></a>
 247   </p>
 248   <p>
 249     <em>Default Browser (Unix)</em><br> It's difficult in Java to
 250     detect the default web browser for Unix users. If Jalview can't find
 251     your default web browser, enter the name or full path to your web
 252     browser application.
 253   </p>
 254   <p>
 255     <em>Proxy Server</em><br> If you normally use a proxy server
 256     for using the internet, you must tick the box &quot;Use a Proxy
 257     Server&quot; and enter the address and port details as necessary.
 258     Web Services will not work if you are using a proxy server and do
 259     not enter the settings here.
 260   </p>
 261   <p>
 262     <em>Usage statistics, Questionnaire and Version checks</em><br>
 263     Uncheck these options to prevent Jalview from submitting usage
 264     statistics to google analytics, checking for Jalview questionnaires
 265     or retrieving details of the latest release version (at
 266     www.jalview.org). See the <a href="../privacy.html">user privacy
 267       statement</a> for more information.
 268   </p>
 269   <p>
 270   <a name="backups"><strong>The &quot;Backups&quot; Preferences Tab</strong></a>
 271   </p>
 272   <p>Since Jalview 2.11.0, overwriting an existing file when saving
 273     or exporting data will by default trigger a backup file to be
 274     created. Several options are provided to control how backup files
 275     are named, and how many old versions will be kept.</p>
 276     <p>
 277     <em>Schemes</em> - select from three default schemes <em>Single Backup</em>, <em>Keep All Versions</em>, and <em>Rolled Backup Files</em>, or choose <em>Custom</em> to enable a previously defined custom scheme.
 278     </p><p>
 279     <em>Custom</em> - Check this box to adjust the parameters of the currently selected scheme. Once <em>OK</em> is selected these parameters will be saved as the <em>Custom</em> scheme in your user preferences. To revert changes hit <em>Cancel</em>.
 280     </p>
 281     <p><em>Scheme Examples</em> - shows how backup files will appear according to the currently selected scheme and parameters.
 282     </p>
 283     <p><em>Deleting Old Backup Files</em> - these settings control how many backups are kept.</p>
 284     <p><em>Backup filename strategy</em> - specify the naming convention for numbered backups and how they are ordered.</p>
 285   <p>
 286     <a name="links"><strong>The &quot;Links&quot; Preferences
 287         tab</strong></a>
 288   </p>
 289   <p>
 290     This panel shows a table, and two sections - <em>Edit</em> and <em>Filter</em>.
 291     The table shows the available URL link definitions (consisting of a
 292     database, Name, and URL template string), a checkbox <em>In
 293       Menu</em> which indicates if the link is enabled, and <em>Double
 294       Click</em> which marks the link that will be opened if a sequence's ID
 295     is double clicked. The table can be sorted by clicking on the column headers.
 296   </p>
 297   <p><em>Edit Links</em><br /> This section contains three buttons,
 298     <em>New</em>, <em>Edit</em> and <em>Delete</em>, which allow you to
 299     create, modify and remove user-defined URL links from the Sequence
 300     ID's links submenu.
 301   </p>
 302   <p>
 303     <em>Filter</em><br /> The <em>Filter text</em> box allows you to
 304     quickly show rows in the table containing a particular text string.
 305     The <em>Custom only</em> button limits the entries in the table to
 306     just those you have configured yourself <em>via</em> the <em>Edit
 307       Links</em> buttons. Press <em>Show all</em> to clear any filters.
 308   </p>
 309   <p>The links table is prepopulated with persistent URLs for many common
 310     bioinformatics databases (since 2.10.2). These links are downloaded by Jalview from
 311     the <em>identifiers.org</em> website, and the names and URLs are not
 312     user editable.
 313     <a href="../webServices/urllinks.html#urllinks">Read more about configuring
 314       URL links.</a>
 315   </p>
 316   <p>
 317     <a name="output"><strong>Output Preferences tab</strong></a>
 318   </p>
 319   <p>
 320     <em>EPS Rendering Style</em><br> This is a selection box which
 321     allows the user to set a default rendering style for EPS export:
 322   <ul>
 323     <li>&quot;Prompt each time&quot;<br> Choose this to be
 324       asked to select between Lineart and Text each time you make an EPS
 325       file.
 326     </li>
 327     <li>&quot;Lineart&quot;<br> EPS files will accurately
 328       reproduce the alignment view in Jalview and all characters will be
 329       converted into line art. Files generated in this way are large and
 330       are not easily editable, but have no font table dependencies.
 331     </li>
 332     <li>&quot;Text&quot;<br> EPS files will be a mixture of
 333       text and lineart. This produces compact files that can be edited
 334       easily in programs like Microsoft Word and Adobe Illustrator, but
 335       can be problematic if the fonts available to Jalview are not
 336       accessible by the program reading the EPS file.
 337   </ul>
 338   <p>
 339     <em>Automatically set ID width</em><br> When enabled, the
 340     column containing sequence and annotation labels at the left hand
 341     side of an exported figure will be made large enough to display each
 342     sequence ID and annotation label in its own line. Enable this if you
 343     have particularly long sequence IDs and need to generate EPS or PNG
 344     figures or web pages.
 345   </p>
 346   <p>
 347     <em>Figure ID column width</em><br> Manually specify the width
 348     of the left hand column where sequence IDs and annotation labels
 349     will be rendered in exported alignment figures. This setting will be
 350     ignored if <em>&quot;Automatically set ID width&quot;</em> is set.
 351   </p>
 352   <p>
 353     <em>Sequence/Start-End Numbering</em><br> The output tab also
 354     has a group of checkboxes for each file format. If these are ticked,
 355     then Jalview will write files with the start and end sequence
 356     positions appended to each sequence id:
 357   <pre>
 358   >ID/1-10
 359   AACDEAAFEA
 360 </pre>
 361   <p>If the boxes are left unchecked for a particular format, the
 362     sequence limits will not be appended to the sequence id.</p>
 363   <p>
 364     <em>Embed BioJSON to HTML export</em>
 365   </p>
 366   <p>
 367     When this option is enabled, Jalview embeds <a
 368       href="bioJsonFormat.html">BioJSON</a> data within HTML files
 369     exported from Jalview at generation time. This enables the exported
 370     HTML files to be extracted and imported back into the Jalview
 371     desktop application at a later time.
 372   <p>
 373     <em>Use Modeller Output</em>
 374   </p>
 375   <p>
 376     This option only applies to PIR format output. Jalview automatically
 377     reads PIR files with sequence descriptions compatible with the
 378     program <a href="http://salilab.org/modeller/">Modeller</a>. If this
 379     option is selected <a href="../io/modellerpir.html">Jalview will
 380       write Modeller style PIR files</a> with correct start/end numbering
 381     and PDB file association (if available). The Jalview id/start-end
 382     option is ignored if Modeller output is selected.
 383   <p>
 384     <a name="editing"><strong>&quot;Editing&quot; Preferences tab</strong></a>
 385   </p>
 386   <p>There are currently three options available which can be
 387     selected / deselected.</p>
 388   <p>
 389     <em>AutoCalculate Consensus</em> - For large alignments it can be
 390     useful to deselect &quot;Autocalculate Consensus&quot; when editing.
 391     This prevents lengthy calculations which are performed after each
 392     sequence edit. New alignment windows will have their
 393     &quot;Autocalculate Consensus&quot; option set according to this
 394     setting.
 395   </p>
 396   <p>
 397     <em>Pad Gaps when Editing</em> - New alignment windows will
 398     &quot;Pad Gaps&quot; according to this setting.
 399   </p>
 400   <p>
 401     <em>Sort with New Tree</em> - When selected, any trees calculated or
 402     loaded onto the alignment will automatically sort the alignment.
 403   </p>
 404     <p>
 405     <a name="hmmer"><strong>&quot;HMMER&quot; Preferences tab</strong></a>
 406   </p>
 407   <p>If you have installed HMMER tools (available from <a href="http://hmmerorg">hmmer.org</a>),
 408   then you should specify on this screen the location of the installation (the path to the folder
 409   containing binary executable programs). Double-click in the input field to open a file browser.</p>
 410   <p>When this path is configured, the <a href="../menus/alwhmmer.html">HMMER menu</a> will be
 411   enabled in the Alignment window.</p>
 412   <p>&nbsp;</p>
 413   <em>Web Services Preferences</em> - documentation for this tab is
 414   given in the
 415   <a href="../webServices/webServicesPrefs.html">Web Services
 416     Preferences section</a>.
 417   <p>&nbsp;</p>
 418 </body>
 419 </html>