657359e86bd8fd79663677b4ceb0117c5118b65d
[jalview.git] / help / html / features / preferences.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
4  * Copyright (C) 2014 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><strong>Preferences</strong></p>
28 <p>The preferences panel is opened from the Jalview Desktop&rsquo;s <strong><em>Tools</em></strong> menu.</p>
29 <p>There are eight tabs in the Preferences dialog box:
30 <ul>
31         <li>The <a href="#visual"><strong>&quot;Visual&quot;</strong>
32         Preferences</a> tab allows you to configure the default display for a new
33         alignment window.</li>
34         <li>The <a href="#colours"><strong>&quot;Colours&quot;</strong>
35         Preferences</a> tab allows you to configure default colourschemes for a new
36         alignment window.</li>
37         <li>The <a href="#structure"><strong>&quot;Structure&quot;</strong>
38         Preferences</a> tab allows you to configure options for obtaining and displaying structure information.</li>
39         <li>The <a href="#connections"><strong>&quot;Connections&quot;</strong>
40         Preferences</a> tab allows you to change the links made from Jalview to
41         your default web browser.</li>
42         <li>The <a href="#output"><strong>&quot;Output&quot;</strong>
43         Preferences</a> tab contains settings affecting the export of sequence
44         alignments and EPS files.</li>
45         <li>The <a href="#editing"><strong>&quot;Editing&quot;</strong>
46         Preferences</a> tab contains settings affecting the export of sequence
47         alignments and EPS files.</li>
48         <li>The <a href="dassettings.html"><strong>&quot;DAS
49         Settings&quot;</strong> Preferences</a> tab allows you to select which DAS sources
50         to use when fetching DAS Features.</li>
51         <li>The <a href="../webServices/webServicesPrefs.html"><strong>&quot;Web Service&quot;</strong> Preferences</a> tab allows you to configure the <a href="http://www.compbio.dundee.ac.uk/jabaws">JABAWS</a> servers that Jalview uses, and change the layout of the alignment's Web Services menu.</li>
52 </ul>
53 </p>
54 <p><strong><a name="visual">Visual</a> Preferences tab</strong></p>
55 <p><em>Maximise Window</em> - If this is selected, a new alignment
56 window will stretch to fit the available space.</p>
57 <p><em>Open Overview Window</em> - When this is selected, the <a
58         href="overview.html">alignment overview</a> panel is opened by default
59 for a new alignment window.</p>
60 <p><em>Show Annotations</em> - If this is selected the new window
61 will display an annotation panel below the sequences. This annotation
62 panel may have several rows describing the whole alignment. The 3
63 standard annotations <em>Conservation</em>, <em>Quality</em> and <em>Consensus</em>
64 for the alignment may be shown or hidden by default using the checkboxes
65 below.</p>
66 <p><em>Show group: Conservation and Consensus</em> controls the
67 display of per-group automatic annotation.</p>
68 <p><em>Consensus: Histogram and Logo</em> checkboxes control the
69 display of the consensus histogram and sequence logo for consensus
70 annotation rows.</p>
71 <p><em>Full Sequence ID</em> - If selected the ID panel will display
72 the name of a sequence plus the start and end residues in the format
73 name/start-end. If not selected, the displayed ID will be the name of
74 the sequence.</p>
75 <p><em>Right Align IDs</em> - select to align all sequence IDs to
76 the left-hand edge of the sequence alignment, rather than the left-hand
77 edge of the alignment display window.</p>
78 <p><em>Font</em> - The default font name, size and style can be set
79 for a new alignment window.</p>
80 <p><em>Sequence ID Tooltip</em>: Control the display of Database
81 References and Non-positional annotation in the tooltip displayed when
82 the mouse is over a sequence's ID.</p>
83 <p><em>Show Unconserved</em> - When this is selected, all consensus sequence 
84 symbols will be rendered as a '.', highlighting mutations in highly conserved alignments.</p>
85 <p><em>Sequence Name Italics</em> - select to apply the italicised
86 version of the font to sequence labels.</p>
87 <p><em>Smooth Font</em> - Toggles anti-aliasing on / off for faster
88 rendering of the alignment.</p>
89 <p><em>Gap Symbol</em> - The default gap symbol may be set to either
90 &quot;-&quot; or &quot;.&quot;</p>
91 <p><em>Wrap Alignment</em> - Select whether to open new alignment
92 windows in wrapped mode or not.</p>
93 <p><em>Sort alignment by</em> - When the alignment is loaded in, it can
94 be ordered as read (No sort), or sorted by Id or pairwise identity.</p>
95 <p><em>Sort annotations by</em> - Annotations can be unsorted, sorted by the order of the related sequences in 
96 the alignment, or by label. Autocalculated annotations (e.g. Consensus) can be shown either last (below sequence 
97 annotations) or first (above sequence annotations). <em>Since Jalview 2.8.2.</em></p>
98 <p><em>Open file</em> - If this is selected then the default
99 alignment file will be opened when Jalview is started. You can change
100 the default file by clicking on file name and either typing in the file
101 path or selecting it from the file chooser window.<br/><em>Note: The default example alignment is updated periodically to demonstrate new features in Jalview.</em></p>
102 <p><a name="colours"><strong>&quot;Colours&quot; Preferences tab</strong></p>
103 <p><em>Alignment Colour</em> - The default colour scheme for a new alignment
104 window. If the chosen option is &quot;User Defined&quot; then the last
105 User Defined Colour loaded or saved via the User Defined Colours panel
106 will be loaded.</p>
107         <p>
108                 <em>Annotation Shading Default</em> - set the default minimum
109                 and maximum colours used when <a
110                         href="../colourSchemes/annotationColouring.html">Colour by
111                         Annotation...</a> is selected from the alignment window's colours menu.
112         </p>
113 <p><a name="structure"><strong>&quot;Structure&quot;
114 Preferences tab</strong></a><em> added in Jalview 2.8.2</em></p>
115 <p><em>Process secondary structure from PDB</em> - if selected, then structure information
116 read from PDB will be processed and annotation added to associated sequences.
117 <p><em>Use RNAView for secondary structure</em> - if selected, the pyRNA RNAView service (<a href="https://github.com/fjossinet/PyRNA">https://github.com/fjossinet/PyRNA</a>) will be 
118 called to derive secondary structure information for RNA chains.
119 <p><em>Add secondary structure annotation to alignment</em> - if selected, <a href="http://swift.cmbi.ru.nl/gv/dssp/">Jmol's implementation DSSP</a> will be used to add annotation to polypeptide chains in the structure.
120 <p><em>Add Temperature Factor annotation to alignment</em> - if selected, values extracted from the Temperature Factor
121 column for the backbone atoms in the PDB file will be extracted as annotation lines shown on the alignment. 
122 <p><em>Default structure viewer</em> - choose JMOL or CHIMERA for viewing 3D structures. 
123 <p><em>Path to Chimera program</em> - Optional, as Jalview will search standard installation paths for Windows, Linux or MacOS. 
124 If you have installed Chimera in a non-standard location, you can specify it here, by entering the full path to the Chimera executable program.
125 Double-click this field to open a file chooser dialog.  
126
127 <p><a name="connections"><strong>&quot;Connections&quot;
128 Preferences tab</strong></a></p>
129 <p><em>URL Link From Sequence ID</em><br>
130 These definitions are used to generate URLs from a sequence's ID or
131 database cross references. Read more about <a
132         href="../webServices/urllinks.html#urllinks">configuring URL links
133 here</a>.</p>
134 <p><em>Default Browser (Unix)</em><br>
135 Its difficult in Java to detect the default web browser for Unix users.
136 If Jalview can't find your default web browser, enter the name or full
137 path to your web browser application.</p>
138 <p><em>Proxy Server</em><br>
139 If you normally use a proxy server for using the internet, you must tick
140 the box &quot;Use a Proxy Server&quot; and enter the address and port
141 details as necessary. Web Services will not work if you are using a
142 proxy server and do not enter the settings here.</p>
143 <p><em>Usage statistics, Questionnaire and Version checks</em><br>
144 Uncheck these options to prevent Jalview from submitting usage
145 statistics to google analytics, checking for jalview questionnaires or
146 retrieving details of the latest release version (at www.jalview.org).
147 See the <a href="../privacy.html">user privacy statement</a> for more
148 information.</p>
149 <p><a name="output"><strong>Output Preferences tab</strong></a></p>
150 <p><em>EPS Rendering Style</em><br>
151 This is a selection box which allows the user to set a default rendering
152 style for EPS export:
153 <ul>
154         <li>&quot;Prompt each time&quot;<br>
155         Choose this to be asked select between Lineart and Text each time you
156         make an EPS file.</li>
157         <li>&quot;Lineart&quot;<br>
158         EPS files will accurately reproduce the alignment view in Jalview and
159         all characters will be converted into line art. Files generated in this
160         way are large and are not easily editable, but have no font table
161         dependencies.</li>
162         <li>&quot;Text&quot;<br>
163         EPS files will be a mixture of text and lineart. This produces compact
164         files that can be edited easily in programs like Microsoft Word and
165         Adobe Illustrator, but can be problematic if the fonts available to
166         jalview are not accessible by the program reading the EPS file.
167 </ul>
168 <p><em>Automatically set ID width</em><br>
169 When enabled, the column containing sequence and annotation labels at the left hand side of an exported figure will be made large enough to display each sequence ID and annotation label in its own line. Enable this if you have particularly long sequence IDs and need to generate EPS or PNG figures or web pages.</p>
170 <p><em>Figure ID column width</em><br>
171 Manually specify the width of the left hand column where sequence IDs and annotation labels will be rendered in exported alignment figures. This setting will be ignored if <em>&quot;Automatically set ID width&quot;</em> is set.
172 </p>
173 <p><em>Sequence//Start-End Numbering</em><br>
174 The output tab also has a group of checkboxes for each file format. If
175 these are ticked, then Jalview will write files with the start and end
176 sequence positions appended to each sequence id: <pre>
177   >ID/1-10
178   AACDEAAFEA
179 </pre>
180 <p>If the boxes are left unchecked for a particular format, the
181 sequence limits will not be appended to the sequence id.</p>
182 <p><em>Use Modeller Output</em></p>
183 <p>This option only applies to PIR format output. Jalview
184 automatically reads PIR files with sequence descriptions compatible with
185 the program <a href="http://salilab.org/modeller/">Modeller</a>. If this
186 option is selected <a href="../io/modellerpir.html">Jalview will
187 write Modeller style PIR files</a> with correct start/end numbering and PDB
188 file association (if available). The Jalview id/start-end option is
189 ignored if Modeller output is selected.
190
191 <p><a name="editing"><strong>Editing Preferences tab</strong></a></p>
192 <p>There are currently three options available which can be selected /
193 deselected.</p>
194 <p><em>AutoCalculate Consensus</em> - For large alignments it can be
195 useful to deselect &quot;Autocalculate Consensus&quot; when editing.
196 This prevents lengthy calculations which are performed after each
197 sequence edit. New alignment windows will have their &quot;Autocalculate
198 Consensus&quot; option set according to this setting.</p>
199 <p><em>Pad Gaps when Editing</em> - New alignment windows will
200 &quot;Pad Gaps&quot; according to this setting.</p>
201 <p><em>Sort with New Tree</em> - When selected, any trees calculated or loaded onto the alignment will automatically sort the alignment.</p>
202 <p>&nbsp;</p>
203 <p>&nbsp;</p>
204 </body>
205 </html>