lots of tidying in doco.
[jalview.git] / help / html / menus / alignmentMenu.html
1 <html>\r
2 <head><title>Alignment Window Menus</title></head>\r
3 \r
4 <body>\r
5 <p><strong>Alignment Window Menus</strong></p>\r
6 <ul>\r
7   <li><strong>File</strong></li>\r
8   <ul>\r
9     <li><strong>Save As<br>\r
10       </strong><em>Save the alignment to local file. A file selection window will\r
11       open, use the &quot;Files of type:&quot; selection box to determine which\r
12       <a href="../io/index.html">alignment format</a> to save as.<br>\r
13       </em></li>\r
14     <li><strong>Export</strong> <em><br>\r
15       Creates an alignment graphic with the current annotation,\r
16       alignment background colours and group colours. If the alignment is <a\r
17       href="../features/wrap.html">wrapped</a>, the output will also\r
18       be wrapped and will have the same visible residue width as the\r
19       open alignment. \r
20       </em>\r
21       <ul>\r
22         <li><strong>HTML<br>\r
23           </strong><em>Create a <a href="../io/index.html#export">web page</a>\r
24           from your alignment.</em></li>\r
25         <li><strong>EPS<br>\r
26           </strong><em>Create an <a href="../io/index.html#export">Encapsulated\r
27           Postscript</a> file from your alignment.</em></li>\r
28         <li><strong>PNG<br>\r
29           </strong><em>Create a <a href="../io/index.html#export">Portable Network\r
30           Graphics</a> file from your alignment.<br>\r
31           </em></li>\r
32       </ul>\r
33     </li>\r
34     <li><strong>Output to Textbox<br>\r
35       </strong><em>The alignment will be displayed in plain text in a new window\r
36       which you can &quot;Copy and Paste&quot; using the pull down menu, or your\r
37       standard operating system copy and paste keys. <br>\r
38       Select the format of the text by selecting one of the following menu items.</em>\r
39       <ul>\r
40         <li><strong>FASTA</strong> <em></em></li>\r
41         <li><strong>MSF</strong></li>\r
42         <li><strong>CLUSTAL</strong></li>\r
43         <li><strong>BLC</strong></li>\r
44         <li><strong>PIR</strong></li>\r
45         <li><strong>PFAM</strong><br></li>\r
46       </ul>\r
47     </li>\r
48     <li><strong>Print<br>\r
49       </strong><em>Jalview will print the alignment using the current fonts and\r
50       colours of your alignment. If the alignment has annotations visible, these\r
51       will be printed below the alignment. If the alignment is wrapped the number\r
52       of residues per line of your alignment will depend on the paper width or\r
53       your alignment window width, whichever is the smaller. <br>\r
54       </em></li>\r
55     <li><strong>Load Associated Tree<br>\r
56       </strong><em>Jalview can <a\r
57       href="../calculations/treeviewer.html">view trees</a> stored in\r
58       the Newick file format, and associate them with the\r
59       alignment. Note: the ids of the tree file and your alignment\r
60       MUST be the same.<br>\r
61       </em></li>\r
62     <li><strong>Close<br>\r
63       </strong><em>Close the alignment window. Make sure you have\r
64       saved your alignment before you close - either as a Jalview\r
65       project or by using the <strong>Save As</strong> menu.<br>\r
66       </em></li>\r
67   </ul>\r
68   <li><strong>Edit</strong></li>\r
69 </ul>\r
70 <blockquote>\r
71   <ul>\r
72     <li><strong>Undo</strong><em><br>\r
73       This will undo any edits you make to the alignment. This applies to insertion\r
74       or deletion of gaps, cutting residues or sequences from the alignment or\r
75       pasting sequences to the current alignment or sorting the\r
76       alignment. <strong>NOTE:</strong> It DOES NOT undo colour\r
77       changes, adjustments to group sizes, or changes to the annotation panel. <br>\r
78       </em></li>\r
79     <li><strong>Redo<br>\r
80       </strong><em>Any actions which you undo can be redone using redo. <br>\r
81       </em></li>\r
82     <li><strong>Cut<br>\r
83       </strong><em>This will make a copy of the currently selected residues before\r
84       removing them from your alignment. Click on a sequence name if you wish\r
85       to select a whole sequence. <br>\r
86       Use &lt;CTRL&gt; and X (&lt;APPLE&gt; and X on MacOSX) to cut.<br>\r
87       </em></li>\r
88     <li><strong>Copy</strong><br>\r
89       <em>Copies the currently selected residues to the system\r
90       clipboard - you can also do this by pressing &lt;CTRL&gt; and C\r
91       (&lt;APPLE&gt; and C on MacOSX). <br>\r
92       If you try to paste the clipboard contents to a text editor, you will see\r
93       the format of the copied residues is a tab separated list:<br>\r
94 <pre>\r
95 NAME    START_RES    END_RES    SEQUENCE\r
96 </pre><br>\r
97       </em></li>\r
98     <li><strong>Paste </strong>\r
99       <ul>\r
100         <li><strong>To New Alignment<br>\r
101           </strong><em>A new alignment window will be created from sequences previously\r
102           copied or cut to the system clipboard. <br>\r
103           Use &lt;CTRL&gt; and V(&lt;APPLE&gt; and V on MacOSX) to paste.</em></li>\r
104         <li><strong>Add To This Alignment<br>\r
105           </strong><em>Copied sequences from another alignment window can be added\r
106           to the current Jalview alignment. <br>\r
107           </em><strong> </strong></li>\r
108       </ul>\r
109     </li>\r
110     <li><strong>Delete<br>\r
111       </strong><em>This will delete the currently selected residues\r
112       without copying them to the clipboard. Like the other edit\r
113       operations, this can be undone with <strong>Undo</strong>.<br>\r
114       </em></li>\r
115     <li><strong>Select All<br>\r
116       </strong><em>Selects all the sequences and residues in the alignment. <br>\r
117       Use &lt;CTRL&gt; and A (&lt;APPLE&gt; and A on a MacOSX) to select all.<br>\r
118       </em></li>\r
119     <li><strong>Deselect All<br>\r
120       </strong><em>Removes the current selection box (red dashed box) from the\r
121       alignment window. All selected sequences, residues and marked columns will\r
122       be deselected. </em><em> <br>\r
123       Use &lt;ESCAPE&gt; to deselect all.<br>\r
124       </em></li>\r
125     <li><strong>Invert Selection<br>\r
126       </strong><em>Any sequence ids currently not selected will replace the current\r
127       selection. <br>\r
128       </em><strong> </strong></li>\r
129     <li><strong>Undefine Groups<br>\r
130       </strong><em>The alignment will be reset with no defined groups.<br> <strong>WARNING</strong>:\r
131       This cannot be undone.<br>\r
132       </em></li>\r
133     <li><strong>Remove Left<br>\r
134       </strong><em>If the alignment has marked columns, the alignment will be\r
135       trimmed to the left of the leftmost marked column. To mark a column, mouse\r
136       click the scale bar above the alignment. Click again to unmark a column,\r
137       or select &quot;Deselect All&quot; to deselect all columns.<br>\r
138       </em></li>\r
139     <li><strong>Remove Right<br>\r
140       </strong><em>If the alignment has marked columns, the alignment will be\r
141       trimmed to the left of the leftmost marked column. To mark a column, mouse\r
142       click the scale bar above the alignment. Click again to unmark a column,\r
143       or select &quot;Deselect All&quot; to deselect all columns.<br>\r
144       </em></li>\r
145     <li><strong>Remove Empty Columns<br>\r
146       </strong><em>All columns which only contain gap characters (&quot;-&quot;,\r
147       &quot;.&quot;) will be deleted.<br>\r
148       You may set the default gap character in <a href="../features/preferences.html">preferences</a>.\r
149       </em><em><br>\r
150       </em></li>\r
151     <li><strong>Remove All Gaps</strong><br>\r
152       <em><strong>All</strong> gap characters (&quot;-&quot;, &quot;.&quot;) will be deleted from\r
153       the alignment.<br>\r
154       You may set the default gap character in <a href="../features/preferences.html">preferences</a>.\r
155       <br>\r
156       </em> </li>\r
157     <li><strong>Remove Redundancy<br>\r
158       </strong><em>Selecting this option brings up a window asking you to select\r
159       a threshold. If the percentage identity between any two sequences\r
160       (under the current alignment) exceeds this\r
161       value then one of the sequences (the shorter) is discarded. Press the &quot;Apply&quot;\r
162       button to remove redundant sequences. The &quot;Undo&quot; button will undo the last\r
163       redundancy deletion.<br>\r
164       </em></li>\r
165     <li><strong>Pad Gaps<br>\r
166       </strong><em>Adds gaps to the end of all the sequences so they\r
167       are all the same length. This is useful for making a tree using\r
168       unaligned sequences.<br>\r
169       You may set the default gap character in <a href="../features/preferences.html">preferences</a>.\r
170       </em></li>\r
171   </ul>\r
172 </blockquote>\r
173 <ul>\r
174   <li><strong>Search</strong></li>\r
175 </ul>\r
176 <blockquote>\r
177   <ul>\r
178     <li><strong>Find<br>\r
179       </strong><em>Select this to <a href="../features/search.html">search</a>\r
180       for residues, sequence name or residue position within the alignment. </em></li>\r
181   </ul>\r
182 </blockquote>\r
183 <ul>\r
184   <li><strong>View</strong></li>\r
185 </ul>\r
186 <blockquote>\r
187   <ul>\r
188     <li><strong>Font<br>\r
189       </strong><em>Change the font of the display from the\r
190       &quot;Choose Font&quot; dialog box, which is shown when this\r
191       item is selected. <br>\r
192       </em></li>\r
193     <li><strong>Wrap<br>\r
194       </strong><em>When ticked, the alignment display is\r
195       &quot;<a href="../features/wrap.html">wrapped</a>&quot; to the\r
196       width of the alignment window. This is useful if your alignment\r
197       has only a few sequences to view its full width at once.<br>\r
198       Options are available to show the residue numbering at the start and/or\r
199       end of an alignment as well as showing the alignment position above each\r
200       sequence row. <br>\r
201       <strong>NOTE</strong>: When in wrapped alignment view, the\r
202       alignment cannot be edited or have regions selected on it. <br>\r
203       </em><strong> </strong></li>\r
204     <li><strong>Show Full Sequence ID<br>\r
205       </strong><em>If this box is selected the sequence name will have the start\r
206       and end position of the sequence appended to the name, in the format NAME/START-END<br>\r
207       </em></li>\r
208     <li><strong>Boxes</strong><em><br>\r
209       If this is selected the background of a residue will be coloured using the\r
210       selected background colour. Useful if used in conjunction with &quot;Colour\r
211       Text.&quot; <br>\r
212       </em></li>\r
213     <li><strong>Text<br>\r
214       </strong><em>If this is selected the residues will be displayed using the\r
215       standard 1 character amino acid alphabet.<br>\r
216       </em></li>\r
217     <li><strong>Colour Text<br>\r
218       </strong><em>If this is selected the residues will be coloured according\r
219       to the background colour associated with that residue. The colour is slightly\r
220       darker than background so the amino acid symbol remains visible. <br>\r
221       </em></li>\r
222     <li><strong>Show Gaps<br>\r
223       </strong><em>When this is selected, gap characters will be displayed as &quot;.&quot;\r
224       or &quot;-&quot;. If unselected, then gap characters will appear as blank spaces.\r
225       <br>\r
226       You may set the default gap character in <a href="../features/preferences.html">preferences</a>.<br>\r
227       </em></li>\r
228     <li><strong>Show Annotations<br>\r
229       </strong><em>If this is selected the &quot;Annotation Panel&quot; will be\r
230       displayed below the alignment. The default setting is to display the conservation\r
231       calculation, quality calculation and consensus values as bar charts. </em><br>\r
232     </li>\r
233     <li><strong>Sequence Features<br>\r
234       </strong><em>If the sequence names are Swissprot entries Jalview will use\r
235       the names to retrieve <a href="../features/seqfeatures.html">sequence features</a> from the EBI. Features which are\r
236       1 residue in length are coloured red, sequences longer than 1 residue are\r
237       coloured blue. Move the mouse over a coloured feature to display the details\r
238       of the feature. <br>\r
239       Note: The retrieved information will update the sequence start and end labels\r
240       if they are incorrect. <br>\r
241       </em></li>\r
242     <li><strong><a href="../features/overview.html">Overview Window</a><br>\r
243       </strong><em>A scaled version of the alignment will be displayed in a small\r
244       window. A red box will indicate the currently visible area of the alignment.\r
245       Move the visible region using the mouse. </em><strong> </strong></li>\r
246   </ul>\r
247 </blockquote>\r
248 <ul>\r
249   <li><strong>Colour</strong></li>\r
250 </ul>\r
251 <blockquote>\r
252   <ul>\r
253     <li><strong>Apply Colour To All Groups<br>\r
254       </strong><em>If this is selected, any changes made to the background colour\r
255       will be applied to all currently defined groups.<br>\r
256       </em></li>\r
257     <li>Colour Scheme options: <strong>None, ClustalX, Blosum62 Score, Percentage Identity, Zappo, Taylor,\r
258       Hydrophobicity, Helix Propensity, Strand Propensity, Turn Propensity, Buried\r
259       Index, Nucleotide, User Defined<br>\r
260       </strong> <em>See <a href="../colourSchemes/index.html">colours</a> for\r
261       a description of all colour schemes.</em><br>\r
262     </li>\r
263     <li><strong>By Conservation<br>\r
264       </strong><em>See <a href="../colourSchemes/conservation.html">Colouring\r
265       by Conservation</a>.</em><br>\r
266     </li>\r
267     <li><strong>Modify Conservation Threshold<br>\r
268       </strong><em>Use this to display the conservation threshold slider window.\r
269       Useful if the window has been closed, or if the 'by\r
270       conservation' option appears to be doing nothing!</em><br></li>\r
271     <li><strong>Above Identity Threshold<br>\r
272       </strong><em>See <a href="../colourSchemes/abovePID.html">Above Percentage\r
273       Identity</a></em><strong>.<br>\r
274       </strong></li>\r
275     <li><strong>Modify Identity Threshold<br>\r
276       </strong><em>Use this to set the threshold value for colouring above Identity.\r
277       Useful if the window has been closed. </em></li>\r
278   </ul>\r
279 </blockquote>\r
280 <ul>\r
281   <li><strong>Calculate</strong></li>\r
282 </ul>\r
283 <blockquote>\r
284   <ul>\r
285     <li><strong>Sort </strong>\r
286       <ul>\r
287         <li><strong>by ID<br>\r
288           </strong><em>This will sort the sequences according to sequence name.\r
289           If the sort is repeated, the order of the sorted sequences will be inverted.\r
290           </em><strong><br>\r
291           </strong></li>\r
292         <li><strong>by Group</strong><strong><br>\r
293           </strong><em>This will sort the sequences according to sequence name.\r
294           If the sort is repeated, the order of the sorted sequences will be inverted.\r
295           </em><strong></strong><strong><br>\r
296           </strong></li>\r
297         <li><strong>by Pairwise Identity<br>\r
298           </strong><em>This will sort the selected sequences by their percentage\r
299           identity to the consensus sequence. The most similar sequence is put\r
300           at the top. </em><strong><br>\r
301           </strong></li>\r
302       </ul>\r
303       <em>The <a href="../calculations/sorting.html">Sort menu</a> will\r
304       have some additional options if you have just done a multiple\r
305       alignment calculation, or opened a tree viewer window.</em><br>\r
306     </li>\r
307     <li><strong>Calculate Tree </strong>\r
308     <br><em>Functions for calculating trees on the alignment or the\r
309     currently selected region. See <a\r
310     href="../calculations/tree.html">calculating trees</a>.</em>\r
311       <ul>\r
312         <li><strong>Average Distance Using % Identity</strong></li>\r
313         <li><strong>Neighbour Joining Using % Identity</strong></li>\r
314         <li><strong>Average Distance Using Blosum62</strong></li>\r
315         <li><strong>Neighbour Joining Using Blosum62<br></strong></li>\r
316       </ul>\r
317     </li>\r
318     <li><strong>Pairwise Alignments</strong><br>\r
319       <em>Applies Smith and Waterman algorithm to selected sequences. See <a href="../calculations/pairwise.html">pairwise alignments</a>.</em><br>\r
320     </li>\r
321     <li><strong>Principal Component Analysis</strong><br>\r
322       <em>Shows a spatial clustering of the sequences based on the\r
323       BLOSUM62 scores in the alignment. See <a href="../calculations/pca.html">Principal Component Analysis</a>.</em>\r
324       <br>\r
325     </li>\r
326     <li><strong>Web Service<br>\r
327       </strong>\r
328         <em>Selecting one of the following menu items starts a remote service\r
329         on compute facilities at the University of Dundee. You need a\r
330         continuous network connection in order to use these services\r
331         through Jalview.\r
332         </em>\r
333       <ul>\r
334         <li><strong>Clustal Alignment</strong><br><em>\r
335         Submits all, or just the currently selected sequences for alignment with clustal W.</em><br></li>\r
336         <li><strong>Clustal Realign</strong><br><em>\r
337         Submits the alignment or currently selected region for\r
338         re-alignment with clustal W. Use this if you have added some\r
339         new sequences to an existing alignment.</em><br></li>\r
340         <li><strong>Muscle Alignment</strong><br><em>\r
341         Submits all, or jut the currently selected sequences for\r
342         alignment using Muscle. Do not use this if you are working with\r
343         nucleic acid sequences.</em><br>\r
344         <li><strong>JNet</strong><br><em>\r
345         Secondary structure prediction by network consensus. The\r
346         behaviour of this calculation depends on the current selection:\r
347         <ul>\r
348         <li>If nothing is selected, and the displayed sequences appear to\r
349         be aligned, then a JNet prediction will be run for the first\r
350         sequence in the alignment, using the current\r
351         alignment. Otherwise the first sequence will be submitted for prediction.\r
352         </li>\r
353         <li>If\r
354         just one sequence (or a region on one sequence) has been selected,\r
355         it will be submitted to the automatic JNet prediction server\r
356         for homolog detection and prediction.\r
357         </li>\r
358 <li>If a set of sequences are selected, and they appear to be aligned,\r
359 then the alignment will be used for a Jnet prediction on the\r
360 <strong>first</strong> sequence selected in the set (that is, the one\r
361 that was first clicked on).\r
362 </li>\r
363               \r
364 </ul>\r
365     </li>\r
366   </ul>\r
367   <p>&nbsp;</p>\r
368 </blockquote>\r
369 </body>\r
370 </html>\r