Revised exercise 1 - launching Jalview in line with 2.11.1.2 changes
[jalview-manual.git] / TheJalviewTutorial.tex
1 %\documentclass[a4paper,11pt]{report}
2 \documentclass[a4paper,11pt]{book}
3 \usepackage[format=hang,margin=10pt]{caption}
4 \usepackage{footnote}
5 \usepackage{graphicx}
6 \usepackage{fouriernc}
7 %\usepackage{amssymb}
8 \usepackage{epstopdf}
9 \usepackage{hyperref}
10 \usepackage{subfigure}
11 \DeclareGraphicsRule{.tif}{png}{.png}{`convert #1 `dirname #1`/`basename #1 .tif`.png}
12 \voffset = -0.5 in
13 \hoffset = -0.85 in
14 \textwidth = 6.5 in 
15 \textheight = 9.5 in 
16 \oddsidemargin = 1.20 in
17 \evensidemargin = 0.2 in
18 \topmargin = 0.0 in 
19 \headheight = 0.35 in
20 \headsep = 0.4 in
21 %\headheight = 0.0 in \headsep = 0.0 in
22 \parskip = 0.2in \parindent = 0.0in
23
24
25 \newtheorem{theorem}{Theorem}
26 \newtheorem{corollary}[theorem]{Corollary}
27 \newtheorem{definition}{Definition}
28
29
30 \title{Jalview 2.10.3: A manual and introductory tutorial }
31 \author{David Martin, James Procter, Andrew Waterhouse, Saif Shehata, Nancy Giang,Suzanne Duce and Geoff Barton}
32 \date{Manual version 1.2.3 6th May 2011}
33
34 \newcommand{\clearemptydoublepage}{\newpage{\pagestyle{empty}}\cleardoublepage}
35
36 % how the hell do we add another panel with text like : This tutorial introduces
37 % the user to the features of Jalview, a multiple sequence alignment editor and
38 % viewer available from http://www.jalview.org to the title page.
39
40 % \renewcommand{menustyle}{\tt} %do something more advanced here.
41
42 \newcounter{ecount} 
43 \newcounter{exstep}[ecount]
44 \renewcommand{\theecount} {\arabic{ecount}}
45 \renewcommand{\theexstep} {\arabic{ecount}.\alph{exstep}}
46
47 \newcommand{\exercise}[2] { 
48 \refstepcounter{ecount}
49 \begin{center} \fbox{\parbox[b][\height]{6in}{ 
50 {\bf
51 % this doesn't work - page refs are off 
52 %  \mbox{\addcontentsline{toc}{subsection}{ Exercise \theecount : #1 } }
53 Exercise \theecount  :  #1  } 
54 \par #2 }} \end{center}
55 \pagebreak[0]
56 }
57 \newcommand{\exstep}[1]{ \stepcounter{exstep} {\sl \theexstep.}  \begin{minipage}[t]{5.5in} #1 \end{minipage} \par \vspace *{1mm} }
58 %%% Remove the % on the next 2 lines to hide tutorials.
59 %\renewcommand{\exercise}[2]{} 
60 %\renewcommand{\exstep}[1]{} 
61
62 \begin{document}
63
64
65 \pagenumbering{}
66
67 %\maketitle
68 % we make our own title because JBP is not clever enough to work out how
69 % to
70 % do
71 % this automatically
72
73 \begin{center}
74
75 {\Huge
76  
77 Jalview 2.11}
78 \vspace{0.5in}
79 {\huge 
80
81 Manual and  Introductory Tutorial }
82
83 \vspace{2.2in}
84
85 {\large
86
87 David Martin, James Procter, Ben Soares 
88
89 Andrew Waterhouse, Saif Shehata, Nancy Giang 
90
91 Mungo Carstairs, Charles Ofoegbu, Kira Mour\~{a}o
92
93 Suzanne Duce and Geoff Barton 
94
95 }
96
97 \vspace{0.9in}
98
99 School of Life Sciences, University of Dundee
100
101 Dundee, Scotland DD1 5EH, UK
102 \vspace{2in}
103
104 Manual Version 1.9.3
105 % post CLS lifesci course on 15th January
106 % draft. Remaining items are AACon, RNA visualization/editing and Protein disorder analysis exercises.
107
108
109 25th September 2020
110
111
112 \end{center}
113
114 %\newpage
115
116 \clearemptydoublepage
117
118 % ($Revision: 1.55 $) 11th October 2010.}
119 % TODO revise for 2.6
120
121 \pagenumbering{roman}
122 \setcounter{page}{1}
123 \tableofcontents 
124 %\clearemptydoublepage
125 % \listoffigures 
126 % \newpage
127 % \listoftables 
128 \newpage
129 \pagenumbering{arabic}
130 \setcounter{page}{1}
131 \chapter{Basics}
132 \label{jalviewbasics}
133 \section{Introduction}
134 \subsection{Jalview}
135 Jalview is a multiple sequence alignment viewer, editor and analysis tool.
136 It is designed to be platform independent (running on Mac, MS Windows, Linux
137 and any other platforms that support Java). Jalview is capable of editing and
138 analysing large alignments (thousands of sequences) with minimal degradation in
139 performance. It is able to show multiple integrated views of the alignment
140 and other data. Jalview can read and write many common sequence formats including
141 FASTA, Clustal, MSF(GCG) and PIR.
142
143
144 There are two types of Jalview program. The {\bf Jalview Desktop} is a standalone 
145 application that provides powerful editing, visualization, annotation and
146 analysis capabilities. The {\bf JalviewJS} that has the same core
147 visualization, editing and analysis capabilities as the desktop, without the
148 desktop's webservice. It is designed to be
149 opened in a web browser,\footnote{A demonstration version of Jalview (Jalview Micro
150 Edition) also runs on a mobile phone but the functionality is limited.} and includes a javascript API.
151
152
153 The Jalview Desktop provides access to protein and nucleic acid sequence, alignment and structure
154 databases, and includes the Jmol\footnote{ Provided under the LGPL licence at
155 \url{http://www.jmol.org}} and Chimera viewer for molecular structures, and the
156 VARNA\footnote{Provided under GPL licence at \url{http://varna.lri.fr}} program for the visualization of RNA secondary structure. It also
157 provides a graphical user interface for the multiple sequence alignment, conservation analysis 
158 and protein disorder prediction methods provided as {\bf Ja}va {\bf B}ioinformatics
159 {\bf A}nalysis {\bf W}eb {\bf S}ervices (JABAWS). JABAWS\footnote{released under GPL at \url{http://www.compbio.dundee.ac.uk/jabaws}} is a system for 
160 running bioinformatics programs that you can download and run on your own machine or cluster, or install on compute clouds.
161
162 \subsection{Jalview's Capabilities}
163 % TODO add references to appropriate sections for each capability described here.
164 Figure \ref{jvcapabilities} gives an overview of the main features of the
165 Jalview desktop application. Its primary function is the editing and
166 visualization of sequence alignments, and their interactive analysis. Tree
167 building, principal components analysis, physico-chemical property conservation
168 and sequence consensus analyses are built into the program. Web services enable
169 Jalview to access online alignment and secondary structure prediction programs,
170 as well as to retrieve protein and nucleic acid sequences, alignments, protein structures and sequence annotation. 
171 Sequences, alignments, trees, structures, features and alignment annotation may also be exchanged with the local filesystem. 
172 Multiple visualizations of an alignment may be worked on simultaneously, and the user interface provides a comprehensive set of controls for colouring and layout. 
173 Alignment views are dynamically linked with Jmol and UCSF Chimera\footnote{UCSF Chimera needs to be installed separately. It is available free for academic use from \url{https://www.cgl.ucsf.edu/chimera/download.html}.} structure displays,
174 a tree viewer and spatial cluster display, facilitating interactive exploration of the alignment's structure. The application provides its own Jalview project file format in order 
175 to store the current state of an alignment and analysis windows. Jalview also provides WYSIWIG\footnote{WYSIWIG: What You See Is What You Get.} style
176  figure generation capabilities for the preparation of alignments for publication.
177 \begin{figure}[htbp]
178 \begin{center}
179 \includegraphics[width=5.8in]{images/jvcapabilities.pdf}
180 \caption{{\bf Capabilities of the Jalview Desktop.} The Jalview Desktop Application provides a stable environment for the creation, editing and analysis of alignments and the generation of figures.}
181 \label{jvcapabilities}
182 \end{center}
183 \end{figure}
184
185 \subsubsection{Jalview History}
186 Jalview was initially developed in 1996 by Michele Clamp, James Cuff, Steve
187 Searle and Geoff Barton at the University of Oxford and then the European
188 Bioinformatics Institute. Development of Jalview 2 was made possible with
189 eScience funding from the BBSRC\footnote{Biotechnology and Biological Sciences
190 Research Council grant  {\sl ``VAMSAS: Visualization and Analysis of Molecules,
191 Sequence Alignments and Structures"}, a joint project to enable interoperability
192 between Jalview, TOPALi and AstexViewer.} in 2004, enabling Andrew Waterhouse and
193 Jim Procter to re-engineer the original program to introduce contemporary developments
194 in bioinformatics and take advantage of the latest web and Java technology.
195 Jalview's development has been supported from 2009
196 onwards by BBSRC funding, and since 2014 by a
197 Wellcome Trust Biomedical Resource grant\footnote{Wellcome grant number 101651/Z/13/Z}. In 2010, 2011, and 2012, Jalview benefitted from the
198 \href{http://code.google.com/soc/}{Google Summer of Code}, when Lauren Lui and Jan Engelhardt introduced new features for handling RNA alignments and secondary structure annotation, in collaboration with Yann Ponty.\footnote{\url{http://www.lix.polytechnique.fr/~ponty/}}
199
200  
201 %TODO describe future plans in history ? not a good idea.
202 % Jalview continues to be one of the worlds most popular\footnote{and in the authors opinion, the best.} sequence alignment and analysis tools.
203
204 \subsubsection{Citing Jalview}
205 If you use Jalview in your work you should cite:\newline
206 {\sl "Jalview Version 2 - a multiple sequence alignment editor and analysis
207 workbench"}\newline Waterhouse, A.M., Procter, J.B., Martin, D.M.A, Clamp, M. and Barton, G. J. (2009) \newline {\sl Bioinformatics}  doi: 10.1093/bioinformatics/btp033
208
209 This paper supersedes the original Jalview publication:\newline {\sl "The
210 Jalview Java alignment editor"} \newline Michele Clamp, James Cuff, Stephen M. Searle and Geoffrey J. Barton (2004) \newline {\sl Bioinformatics} {\bf 20} 426-427. 
211
212   
213 \subsection{About this Tutorial }
214
215 This tutorial is written in a manual format with short exercises where
216 appropriate. The first few sections concerns the
217 basic operation of Jalview and should be sufficient for those who want to
218 launch Jalview (Section \ref{startingjv}), open an alignment (Section
219 \ref{loadingseqs}), perform basic editing (Section
220 \ref{selectingandediting}), colouring (Section \ref{colours}), and produce
221 publication and presentation quality graphical output (Section \ref{layoutandoutput}).
222
223 The remaining sections of the manual cover the visualization and
224 analysis techniques available in Jalview. These include working
225 with the embedded Jmol molecular structure viewer (or UCSF Chimera), building
226 and viewing trees and Principal Components Analysis (PCA) plots, and using
227 trees for sequence conservation analysis. Section \ref{featannot} details the creation and visualization of sequence,
228 features and alignment annotation. The alignment and secondary structure prediction services are described
229 in detail in Sections \ref{msaservices} and \ref{protsspredservices}
230 respectively. Section \ref{workingwithnuc} discusses
231 specific features of use when working with nucleic acid sequences, such as translation and linking to protein coding regions, and 
232 the display and analysis of RNA secondary structure.  An overview of
233 the Jalview Desktop's webservices is given in Section \ref{jvwebservices}.
234
235 %^Chapter \ref{jalviewadvanced} The third chapter covers the detail^ of Jalview and is aimed at the user who is
236 %already familiar with Jalview operation but wants to get more out of their
237 %Jalview experience.
238
239 \subsubsection{Typographic Conventions}
240
241 Keystrokes using the special non-symbol keys are represented in the tutorial by
242 enclosing the pressed keys with square brackets ({\em e.g.} [RETURN] or [CTRL]).
243
244 Keystroke combinations are denoted with a `-' symbol ({\em
245 e.g.} [CTRL]-C means press [CTRL] and the `C' key simultaneously).
246
247 Menu options are given as a path from the menu
248 that contains them. For example {\sl File $\Rightarrow$ Input Alignment
249 $\Rightarrow$ From URL} means to select the `From URL' option from the `Input
250 Alignment' submenu of a window's `File' dropdown menu.
251
252 \section{Launching the Jalview Desktop Application}
253 \label{startingjv}
254 \begin{figure}[htbp]
255 \begin{center}
256 \includegraphics[width=4.5in]{images/download.pdf}
257 \caption{\bf Download page on the Jalview web site at www.jalview.org.}
258 \label{download}
259 \end{center}
260 \end{figure}
261
262 This tutorial is based on the Jalview Desktop application. Much of the
263 information will also be useful for users of the JalviewJS, which has the same
264 core editing, analysis and visualization capabilities. The Jalview Desktop,
265 however, is much more powerful, and includes additional support for interaction
266 with external web services, powerful molecular graphics programs, and production
267 of publication quality graphics.
268
269 The Jalview Desktop application can be downloaded from the download link on the
270 Jalview website, which takes you to
271 \href{http://www.jalview.org/download}{(www.jalview.org/download)}. The page
272 automatically displays the options available for your computer (e.g. if you have
273 Mac or PC), and a button to show all available downloads. These include special
274 'executable Jar' distributions useful if you want to run a specific version of
275 Jalview.
276 To ensure you are running the latest version of Jalview, we recommend
277 downloading the Jalview Desktop Installer package for your platform, clicking on
278 the downloaded file and following the instructions to install it.
279 Once installed, the Jalview Application will automatically update itself when a
280 new version is released.
281
282 When the Jalview Desktop application is launched, you will first see a loading
283 screen whilst it checks for updates, then the program will start with the
284 Jalview splash screen (Figure \ref{splash}).
285 This gives information about the version and build date that you are running,
286 information about later versions (if available), and the paper to cite in your
287 publications. This information is also available on the Jalview web site at
288 \url{http://www.jalview.org}.
289
290 %[fig 2] 
291 \begin{figure}[htbp]
292
293 \begin{center}
294 \includegraphics[width=4.5in]{images/splash.pdf}
295 \caption{{\bf Jalview splash screen.}}
296 \label{splash}
297 \end{center}
298 \end{figure}
299
300 When Jalview starts it will automatically load an example alignment from the
301 Jalview site. This behaviour can be switched off in the Jalview Desktop
302 preferences dialog  by unchecking the open file option.
303 This alignment will look like the one in Figure \ref{startpage} (taken
304 from Jalview version 2.10.1).
305
306 %[figure 3 ]
307 \begin{figure}[htbp]
308 \begin{center}
309 \includegraphics[width=4in]{images/start.pdf}
310 \caption{{\bf Default startup for Jalview.}}
311 \label{startpage}
312 \end{center}
313 \end{figure}
314
315 \exercise{Launching Jalview from the Jalview Website}{
316 \label{start}
317 \exstep{Open the Jalview web site
318 \href{http://www.jalview.org}{(www.jalview.org)}
319 in your web browser. To instal Jalview, first click the 'Download' link in the top right hand corner of the Jalview homepage. This
320 will open the download webpage, the options available will reflect if you have Mac or PC computer.}
321 \exstep {Download the application by clicking the download link as appropriate for your computer operating system.}
322 \exstep {Instal the Jalview application by going to the download folder and 
323 clicking on the downloaded file, and follow the instructions.}
324 \exstep {If you are having any issues, it may help changing the browser.}
325 \exstep{To disable opening of the demonstration project during the launch, go
326 to the {\sl Tools $\Rightarrow$
327 Preferences...} menu on the desktop. A `Preference'
328 dialog box opens, untick the box adjacent to the `Open file' entry in the
329 `Visual' preferences tab.
330 Click {\sl OK} to save the preferences.}
331 %%\exstep{Quit Jalview and open it again to check that the
332 %%The example alignment is not loaded wehn Jalview starts up.}
333 \exstep{To reload the original demo file select the
334 {\em File$\Rightarrow$ From URL} entry in the Desktop menu. Click on
335 the URL history button (a downward arrow on the right hand side of the dialog
336 box) to view the files, select exampleFile\_2\_7.jvp
337 (shown as \url{https://www.jalview.org/examples/exampleFile_2_7.jvp}) 
338 then click {\sl OK}.}
339 \begin{list}{$\circ$}{\newline
340   \newline {\bf
341   Notes}}
342   
343 \item {To make Jalview display a different alignment when it is launched, then go
344 to the {\sl Tools $\Rightarrow$
345 Preferences...} menu on the desktop. Then tick the `Open file' entry of `Visual'
346 preferences tab, type in the URL of the sequence you want to load.}
347 \end{list}
348
349 {\bf See the video at:
350 \url{http://www.jalview.org/Help/Getting-Started}.}
351  }
352
353 \subsubsection{Jalview News RSS Feed}
354
355 Announcements are made available to users of the
356 Jalview Desktop {\sl via} the Jalview Newsreader. This window will open
357 automatically when new news is available, and can also be accessed {\sl via} the
358 Desktop's {\sl Tools $\Rightarrow$ Show Jalview News} menu entry. 
359
360 \begin{figure}[htbp]
361 \begin{center}
362 \includegraphics[height=3in]{images/jvrssnews.pdf}
363 \caption{{\bf The Jalview News Reader.} The newsreader opens automatically
364 when new articles are available from the Jalview Desktop's news channel.}
365 \label{jalviewrssnews}
366 \end{center}
367 \end{figure}
368
369 \subsection{Getting Help}
370 \label{gettinghelp}
371 \subsubsection{Built in Documentation}
372 Jalview has comprehensive on-line help documentation. Select  {\sl Help
373 $\Rightarrow$ Documentation} from the main desktop window menu and a new window
374 will open (Figure \ref{help}). The appropriate topic can then be selected from the
375 navigation panel on the left hand side. To search for a specific topic, click
376 the `search' tab and enter keywords in the box which appears.
377
378 \subsubsection{Email Lists}
379
380 The Jalview Discussion list ({\tt jalview-discuss@jalview.org}) provides a forum
381 for Jalview users and developers to raise problems and exchange ideas - any
382 problems, bugs, and requests for help should be raised here. The {\tt
383 jalview-announce@jalview.org} list can also be subscribed to if you wish to be
384 kept informed of new releases and developments. 
385
386 Archives and mailing list
387 subscription details can be found in the Jalview web site's \href{http://www.jalview.org/community}{community section}.
388
389 \begin{figure}[htbp]
390 \begin{center}
391 \parbox[c]{2in}{\centerline{\includegraphics[width=2.75in]{images/help1.pdf}}}
392 \parbox[c]{4in}{\includegraphics[width=4in]{images/help2.pdf}}
393 \caption{{\bf Accessing the built in Jalview documentation.}}
394 \label{help}
395 \end{center}
396 \end{figure}
397
398
399
400
401 \section{Navigation}
402 \label{jvnavigation}
403 The major features of the Jalview Desktop are illustrated in Figure \ref{anatomy}. The alignment window is the primary window for editing and visualization, and can contain several independent views of the alignment being worked with. The other windows (Trees, Structures, PCA plots, etc) are linked to a specific alignment view. Each area of the alignment window has a separate context menu accessed by clicking the right mouse button.  
404
405  Jalview has two navigation and editing modes: {\bf normal mode}, where
406  editing and navigation is performed using the mouse, and {\bf cursor mode}
407  where editing and navigation are performed using the keyboard. The {\bf F2}
408  key is used to switch between these two modes. 
409  
410  {\em Note:} On MacBooks and other laptops with compact keyboards, you may need
411  to press the function key {\bf [Fn]} when pressing any of the numbered function
412  keys. So to toggle between keyboard and normal mode, press {\bf [Fn]-[F2]}.
413  
414
415 \begin{figure}[htb]
416 \begin{center}
417 \includegraphics[width=6.5in]{images/jalview_anatomy.pdf}
418 \caption{{\bf The anatomy of Jalview.} The major features of the Jalview Desktop
419 Application are labeled.}
420 % TODO: modify text labels to be clearer - black on grey and black border for clarity
421 \label{anatomy}
422 \end{center}
423 \end{figure}
424
425  \exercise{Navigation}{
426 \label{navigationEx}
427 Jalview has two navigation and editing modes: {\bf normal} mode (where editing
428 and navigation are via the mouse) and the {\bf cursor} mode (where editing and
429 navigation are via the keyboard).
430 The {\bf F2} key is used to switch between these two modes. With a Mac, the key
431 combination {\bf Fn and F2} keys are needed, as the {\bf F2} button is
432 often assigned to screen brightness. Jalview always starts up in normal mode.
433
434 \exstep{Load an example alignment from its URL
435 (\url{http://www.jalview.org/examples/exampleFile_2_7.jar}) via the Desktop
436 using {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ from URL} dialog
437 box.
438 (The URL should be stored in its history and clicking on the {\sl down arrow}
439 on the dialog box is an easy way to access it.)}
440 \exstep{Scroll around the alignment using the alignment (vertical) and ruler (horizontal) scroll bars.}
441 \exstep{Find the Overview Window, {\sl View
442 $\Rightarrow$ Overview Window} and open it. Move around the
443 alignment by clicking and dragging the red box in the overview window.}
444 \exstep{Return to the alignment window, look at the status bar (lower left
445 hand corner of the alignment window) as you move the mouse over the alignment. It indicates information about the
446 sequence and residue under the cursor.}
447 \exstep{Press [F2] key, or [Fn]-[F2] on Mac, to enter Cursor mode. Use
448 the direction keys to move the cursor around the alignment.}
449 \exstep{Move to sequence 7 by pressing {\bf 7 S}. Move to column 18 by pressing
450 {\bf 1 8 C}. Move to residue 18 by pressing {\bf 1 8 P}. Note that these can be
451 two different positions if gaps are inserted into the sequence. Move to sequence 5,
452 column 13 by typing {\bf 1 3 , 5} [RETURN].}
453
454 {\bf Note:} To view Jalview's comprehensive on-line help documentations select
455 {\sl Help} in desktop window menu, clicking on {\sl Documentation} will open a
456 Documentation window. Select topics from the navigation panel on the left hand
457 side or use the Search tab to locate specific key words.
458
459 {\sl\bf See the video at: 
460 \url{http://www.jalview.org/Help/Getting-Started}.}
461
462
463 \subsection{Navigation in Normal Mode}
464
465 Jalview always starts up in Normal mode, where the mouse is used to interact
466 with the displayed alignment view. You can move about the alignment by clicking
467 and dragging the ruler scroll bar to move horizontally, or by clicking and
468 dragging the alignment scroll bar to the right of the alignment to move
469 vertically.  If all the rows or columns in the alignment are displayed, the
470 scroll bars will not be visible.
471
472  Each alignment view shown in the alignment window presents a window onto the
473  visible regions of the alignment. This means that with anything more than a few
474  residues or sequences, alignments can become difficult to visualize on the
475  screen because only a small area can be shown at a time. Here, it helps, to
476  have an overview of the whole alignment, especially when it is large.
477  Select {\sl View $\Rightarrow$ Overview Window} from the Alignment
478  window menu bar (Figure \ref{overview}).
479 % (Figure4)
480 \begin{figure}[htbp]
481 \begin{center}
482 \includegraphics[width=4.5in]{images/overview.pdf}
483 \caption{{\bf Alignment Overview Window.} The overview window for a view is
484 opened from the {\em View} menu.}
485 \label{overview}
486 \end{center}
487 \end{figure}
488
489 The red box in the overview window shows the current view in the alignment
490 window. A percent identity histogram is plotted below the alignment overview.
491 Shaded parts indicate rows and columns of the alignment that are hidden (for more information see Section
492 \ref{hidingregions}). You can navigate around the alignment by dragging the red
493 box. 
494
495 %Try this now and see how the view in the alignment window changes.
496
497 \parbox[c]{3in}{Alignment and analysis windows are closed by clicking on the
498 usual `close' icon (indicated by arrows on Mac OS X). If you want to close all
499 the alignments and analysis windows at once, then use the {\sl Window
500 $\Rightarrow$ Close All} option from the Jalview desktop.
501
502 {\bf \em{Warning: Make sure you have saved your work because this cannot be
503 undone!}} }
504 \parbox[c]{3in}{\centerline{\includegraphics[width=2.5in]{images/start_closeall.pdf}
505 }}
506
507
508 \subsection{Navigation in Cursor Mode}
509 \label{cursormode}
510 \parbox[c]{5in}{Cursor mode navigation enables the user to quickly
511 and precisely navigate, select and edit parts of an alignment. On pressing F2 to
512 enter cursor mode the position of the cursor is indicated by a black background
513 and white text. The cursor can be placed using the mouse or moved by pressing
514 the arrow keys ($\uparrow$, $\downarrow$, $\leftarrow$, $\rightarrow$).
515 }\parbox[c]{1.25in}{\centerline{\includegraphics[width=0.8in]{images/cursor1.pdf}}}
516
517 Rapid movement to specific positions is accomplished as listed below:
518 \begin{list}{$\circ$}{}
519 \item {\bf Jump to Sequence {\sl n}:} Type a number {\sl n} then press [S] to
520 move to sequence (row) {\sl n}.
521 \item {\bf Jump to Column {\sl n}:} Type a number {\sl n} then press [C] to move to column {\sl n} in the alignment.  
522 \item {\bf Jump to Residue {\sl n}:} Type a number {\sl n} then press [P] to move to residue number {\sl n} in the current sequence.  
523 \item {\bf Jump to  column {\sl m} row {\sl n}:} Type the column number {\sl m}, a comma, the row number {\sl n} and press [RETURN]. 
524 \end{list}
525 \subsection{The Find Dialog Box}
526 \label{searchfunction}
527 A further option for navigation is to use the {\sl Select $\Rightarrow$
528 Find\ldots} function. This opens a dialog box into which can be entered regular
529 expressions for searching sequences and sequence IDs, or sequence numbers.
530 Hitting the [Find next] button will highlight the first (or next) occurrence of
531 that pattern in the sequence ID panel or the alignment, and will adjust the view
532 in order to display the highlighted region. The Jalview Help provides
533 comprehensive documentation for this function, and a quick guide to the regular
534 expressions that can be used with it.
535 %TODO insert a figure for the Find dialog box
536
537 \section{Loading Sequences and Alignments}
538 \label{loadingseqs}
539 %Jalview provides many ways to load your own sequences. %For this section of the
540 % tutorial you will need to download the file http://www.jalview.org/tutorial/alignment.fa to a suitable location on your hard drive.
541 \subsection{Drag and Drop}
542         In most operating systems you can drag a file icon from a file browser
543         window and drop it on an open Jalview application window. The file will then be opened as a new alignment window. 
544         %You can try this with the tutorial file you have downloaded. When you have opened the file, close it again by selecting the close control on the window. If you drop an alignment file onto an open alignment window it will be appended.
545         Drag and drop also works when loading data from a URL -
546 simply drag the link or url from the address panel of your browser onto an
547 alignment or the Jalview desktop background and Jalview will load data from the
548 URL directly.
549 %  (Figure \ref{drag})
550 % %[fig 5]
551 % \begin{figure}[htbp]
552 % \begin{center}
553 % \includegraphics[width=2in]{images/drag2.pdf}
554 % \includegraphics[width=2in]{images/drag3.pdf}
555 % \caption{{\bf An alignment can be opened by dragging the file onto the Jalview window. }}
556 % \label{drag}
557 % \end{center}
558 % \end{figure}
559
560 % %\includegraphics[width=2in]{images/drag1.pdf}
561
562
563 \subsection{From a File}
564 Jalview can read sequence alignments from a sequence alignment file. This is a
565 text file, {\bf not} a word processor document. For entering sequences from a
566 wordprocessor document see Cut and Paste  (Section \ref{cutpaste}). Select
567 {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ From File} from the main
568 menu (Figure \ref{loadfile}). You will then get a file selection window where
569 you can choose the file to open. Remember to select the appropriate file type.
570 Jalview can automatically identify some sequence file formats.
571
572 %[fig 6]
573 \begin{figure}[htbp]
574 \begin{center}
575 \includegraphics[width=2in]{images/loadfilebox.pdf}
576 %\includegraphics[width=2in]{images/loadfilebox2.pdf}
577 \includegraphics[width=3in]{images/loadfileboxdrop.pdf}
578 \caption{{\bf Opening an alignment from a file saved on disk. }}
579 \label{loadfile}
580 \end{center}
581 \end{figure}
582
583
584 \exercise{Loading Sequences}{
585 \label{load}
586 \exstep{Use {\sl Window $\Rightarrow$ Close All} from the Desktop window menu to
587 close all windows.}
588 %% TODO: omit or combine this exercise
589 %% NB. Edge (MS default browser) doesn't actually allow you to 'save' the page, apparently
590 \exstep{{\bf Loading sequences from URL:} Selecting {\sl File $\Rightarrow$
591 Input Alignment $\Rightarrow$ From URL} from the Desktop and enter \url{http://www.jalview.org/tutorial/alignment.fa} in the box.
592 Click {\sl OK} to load the alignment.}
593
594 %%TODO: omit or combine
595 \exstep{{\bf Loading sequences from a file:} Close all windows using the
596 {\sl Window $\Rightarrow$ Close All} menu option from the Jalview desktop.
597 Then type the same URL (\url{http://www.jalview.org/tutorial/alignment.fa}) into
598 your web browser. Then from the browser, save the fasta file (.fa) file to your desktop using {\sl File
599 $\Rightarrow$ Save Page as}.
600 Open the file you have just saved on your computer in Jalview by selecting {\sl File
601 $\Rightarrow$ Input Alignment $\Rightarrow$ From File} from the desktop menu.
602 Select the file and click {\sl OK} to load.}
603
604 \exstep{{\bf Loading sequences by `Drag and Drop' / `Cut and Paste':}
605
606 (i) Drag the alignment.fa file that you have just saved on your computer from its folder and
607 drop it onto the Jalview desktop window, the alignment should open.
608
609 (ii) Open
610 \url{http://www.jalview.org/examples/estrogenReceptorProtein.fa} in a web
611 browser. Test the differences
612 between (a) dragging the URL directly from browser onto the Jalview
613 desktop.
614 (If the URL is downloaded, alternatively locate the file in your download
615 directory and drag it onto the desktop.) (b) dragging the URL from
616 browser onto the existing alignment.fa alignment window in the Jalview desktop.
617
618 (iii) Open \url{http://www.jalview.org/examples/estrogenReceptorCdna.fa} in a web
619 browser. Note that this is a cDNA file. Drag the URL from
620 browser onto the estrogenReceptorProtein.fa protein alignment window in
621 the Jalview desktop. A dialogue box opens asking `Would you like to open as split
622 window, with cDNA and protein linked?' select `Split Window' option. A
623 split window opens in the Jalview desktop.
624 }
625
626 \exstep{{\bf The text editor:} 
627
628 (i) Open the alignment.fa file that you saved previously using text editor.
629 Copy the sequence text into the clipboard  using [CTRL]-A and then [CTRL]-C.
630
631 (ii) Move the mouse pointer onto the Jalview desktop window's background and right-click 
632 to open the context window. Select the {\sl Paste to New Window} menu option.
633
634 (iii) In the Jalview desktop menu, select {\sl File
635 $\Rightarrow$ Input Alignment $\Rightarrow$ From Textbox}.
636 Paste the clipboard into the large window using [CTRL]-V. Click {\sl New Window}
637 and the alignment will be loaded.}
638
639 \exstep{{\bf Loading sequences from Public Database:} (i) Select {\sl File
640 $\Rightarrow$ Fetch Sequences...} from the Jalview desktop menu. The {\sl
641 Select Database Retrieval Source} dialog will open listing all the database
642 sources. Select the {\bf PFAM seed} database and click {\sl OK}.
643
644 (ii) The {\sl New
645 Sequence Fetcher} window will open. Enter the accession number {\bf PF03460}
646 and click {\sl OK}.
647 An alignment of about 174 sequences should load.}
648 \exstep{These can be viewed using the Overview window accessible from {\sl View
649 $\Rightarrow$ Overview Window.}}
650 {\bf See the video at:
651 \url{http://www.jalview.org/Help/Getting-Started}} }
652
653
654 \subsection{From a URL}
655 Jalview can read sequence alignments directly from a URL. Please note that the
656 files must be in a sequence alignment format - an HTML alignment or graphics
657 file cannot be read by Jalview.
658 Select {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ From URL} from the
659 main menu and a window will appear asking you to enter the URL (Figure
660 \ref{loadurl}). Jalview will attempt to automatically discover the file format.
661
662 %[fig 7]
663 \begin{figure}[htbp]
664 \begin{center}
665 \includegraphics[width=2in]{images/menuloadurl.pdf}
666 \includegraphics[width=3in]{images/loadurlbox.pdf}
667 \caption{{\bf Opening an alignment from a URL. }}
668 \label{loadurl}
669 \end{center}
670 \end{figure}
671
672 \subsection{Cut and Paste}
673 \label{cutpaste}
674 Documents such as those produced by Microsoft Word cannot be readily understood
675 by Jalview. The way to read sequences from these documents is to select the
676 data from the document and copy it to the clipboard. There are two ways to
677 do this. One is to right-click on the desktop background, and select the
678 `Paste to new window' option in the menu that appears. The other is to select
679 {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ From Textbox} from the
680 main menu, paste the sequences into the text window that will appear, and select
681 {\sl New Window} (Figure \ref{loadtext}). In both cases, presuming that they are
682 in the right format, Jalview will happily read them into a new alignment window.
683 %[fig 8]
684
685 \begin{figure}[htbp]
686 \begin{center}
687 \includegraphics[width=2in]{images/menuloadtext.pdf}
688 \includegraphics[width=3in]{images/loadtextbox.pdf}
689 \caption{{\bf Opening an alignment from pasted text. }}
690 \label{loadtext}
691 \end{center}
692 \end{figure}
693
694
695 \subsection{From a Public Database}
696 \label{fetchseq}
697 Jalview can retrieve sequences and sequence alignments from the public databases
698 housed at the European Bioinformatics Institute, including Uniprot, Pfam, Rfam
699 and the PDB. Jalview's sequence fetching capabilities allow you to avoid having to
700 manually locate and save sequences from a web page before loading them into
701 Jalview. It also allows Jalview to gather additional metadata provided by the
702 source, such as annotation and database cross-references.
703
704 To begin retrieving data, select {\sl File $\Rightarrow$ Fetch Sequences \ldots} 
705 from the main menu. A window will then appear (Figure \ref{loadseq}) showing all 
706 the database sources Jalview can access (grouped by the type of database). Once 
707 you've selected the appropriate database by double clicking it or hitting OK, the 
708 database selection window will close and the sequence fetcher for that database 
709 will appear. You can then enter one or several database IDs or accession numbers 
710 separated by a semicolon and press OK. Jalview will then attempt to retrieve them 
711 from the chosen database. Example queries are provided for some databases to test
712 that a source is operational, and can also be used as a guide for the type of 
713 accession numbers understood by the source.
714 % [fig 9]
715 \begin{figure}[htbp]
716 \begin{center}
717 \includegraphics[width=5in]{images/fetchseq.pdf}
718 \caption{{\bf Retrieving sequences from a public database.}}
719 \label{loadseq}
720 \end{center}
721 \end{figure}
722  
723  \subsection{Memory Limits}
724 \label{memorylimits}
725 Jalview 2.11 and later will automatically maximise the amount of memory available,
726 but if you are using an earlier version or launching Jalview in a specialised way
727 you may need ensure that you have allocated enough memory to
728 work with your data. On most occasions, Jalview will warn you when you have
729 tried to load an alignment that is too big to fit in to memory (for instance,
730 some of the PFAM alignments are {\bf very} large). You can find out how much
731 memory is available to Jalview with the desktop window's {\sl $\Rightarrow$
732 Tools $\Rightarrow$ Show Memory Usage} function, which enables the display of
733 the currently available memory at the bottom left hand side of the Desktop
734 window's background. Should you need to increase the amount of memory available
735 to Jalview, full instructions are given in the built in documentation (opened by
736 selecting {\sl Help $\Rightarrow$ Documentation}) and on the JVM memory
737 parameters page (\url{http://www.jalview.org/jvmmemoryparams.html}).
738
739
740 \section{Saving Sequences and Alignments}
741 \label{savingalignments} 
742 \subsection{Saving Alignments} Jalview allows alignments to be saved to file
743 in a variety of formats so they can be restored at a later date, passed to
744 colleagues or analysed in other programs. From the alignment window menu select {\sl File $\Rightarrow$ Save As} and a dialog box
745 will appear (Figure \ref{savealign}). You can navigate to an appropriate
746 directory in which to save the alignment. Jalview will remember the last filename
747 and format used to save (or load) the alignment, enabling you to quickly save
748 the file during or after editing by using the {\sl File $\Rightarrow$ Save}
749 entry. The {\sl File $\Rightarrow$ Output To Textbox} menu option allows the alignment to be copied and pasted into
750 other documents or web servers.
751
752 Jalview offers several different formats in which an alignment can be saved.
753 Of these, only the jalview project format (.jar or .jvp) will preserve the colours, groupings and other additional information in the alignment. The other formats
754 produce text files containing just the sequences with no visualization information, although some
755 allow limited annotation and sequence features to be stored (e.g. AMSA).
756 Unfortunately, as far as we are aware only Jalview can read Jalview
757 project files.
758
759 %[fig 10]
760 \begin{figure}[htbp]
761 \begin{center}
762 \parbox[c]{3.0in}{
763 \includegraphics[width=3in]{images/saveas.pdf}
764 }
765 \parbox[c]{3in}{
766 \includegraphics[width=3in]{images/saveas2.pdf}
767 }
768 \caption{{\bf Saving alignments in Jalview to disk.}}
769 \label{savealign}
770 \end{center}
771 \end{figure}
772
773 \exercise{Saving Alignments}{
774 \label{save}
775 \exstep{Launch Jalview afresh, or use {\sl Desktop $\Rightarrow$ Window
776 $\Rightarrow$ Close all }.}
777 \exstep{Load the ferredoxin
778 alignment ({\bf PF03460}) from {\bf PFAM (seed)} (see Exercise
779 \ref{load}).
780 } \exstep{
781
782 Select {\sl File $\Rightarrow$ Save As} from the alignment window menu. Choose a
783 location into which to save the alignment and select your preferred format. All
784 formats except {\sl  Jalview } jvp can be viewed in a normal text editor (e.g.
785 Notepad) or in a web browser.
786 Enter a file name, select file type and click {\sl Save}.}
787 \exstep{Check this file by closing all windows and opening it with Jalview, or by
788 browsing to it with your web browser.}
789 \exstep{Repeat the previous steps saving the files in different file formats.}
790 \exstep{Open the files in a normal text editor and compare the appearance of the different file formats.}
791 \exstep{Select {\sl File $\Rightarrow$ Output to Textbox $\Rightarrow$ FASTA}.
792 Select and copy this alignment to the clipboard using the textbox menu options
793 {\sl Edit $\Rightarrow$ Select All} followed by {\sl Edit $\Rightarrow$ Copy}.
794 The alignment can then be pasted into any application of choice, e.g. a word processor or web form.
795 }
796 \exstep{Ensure at least one alignment window is active in Jalview. Open the
797 overview window {\sl View $\Rightarrow$ Overview Window}
798  and click and drag to move the red box to any part of the alignment.
799 Select {\sl File
800 $\Rightarrow$ Save Project} from the desktop window menu and save the project in a
801 suitable folder.}
802
803 \exstep{Close all windows and then load the project {\sl via} the {\sl File
804 $\Rightarrow$ Load Project} menu option. Observe how many of the windows
805 reopen. Are they the same as when they were saved ? } {\bf See the video at:
806 \url{http://www.jalview.org/Help/Getting-Started}.} }
807
808 \subsection{Jalview Projects}
809 \parbox[c]{4in}{If you wish to save a complete Jalview session rather than
810 just a single alignment (e.g. because you have calculated trees or multiple
811 different alignments) then save your work as a Jalview Project
812 file (.jvp).\footnote{Tip: Ensure that you have allocated plenty of memory to
813 Jalview when working with large alignments in Jalview projects. See Section 
814 \ref{memorylimits} for how to do this.}
815 From the main menu select {\sl File $\Rightarrow$ Save Project} and a file save
816 dialog box will appear. Loading a project will restore Jalview to exactly the
817 view at which the file was saved, complete with all alignments, trees,
818 annotation and displayed structures rendered appropriately.
819 } \parbox[c]{2.3in}{ \centerline {
820 \includegraphics[width=2.2in]{images/saveproj.pdf} }}
821
822
823 \chapter{Selecting and Editing Sequences }
824 \label{jalviewediting}
825
826 \label{selectingandediting} 
827 Jalview makes extensive use of selections - most of the commands available from
828 its menus operate on the {\sl currently selected region} of the alignment, either to
829 change their appearance or perform some kind of analysis. This section
830 illustrates how to make and use selections and groups.
831
832 \section{Selecting Parts of an Alignment}
833 Selections can be of arbitrary regions in an alignment, one or more complete columns, or one or 
834 more complete sequences.
835 A selected region can be copied and pasted as a new alignment 
836 using the {\sl Edit $\Rightarrow$ Copy} and {\sl Edit $\Rightarrow$ Paste $\Rightarrow$ To New 
837 Alignment}  in the alignment window menu options.
838 {\bf To clear (unselect)  the selection press the [ESC] key.}
839
840 \subsection{Selecting Arbitrary Regions}
841 To select part of an alignment, place the mouse at the top left corner of the region you wish to select. Press and hold the mouse button and drag the mouse to the bottom right corner of the chosen region then release the mouse button. 
842 A dashed red box appears around the selected region (Figure \ref{select}). 
843 %[fig 12]
844
845 \begin{figure}[htbp]
846 \begin{center}
847 \includegraphics[width=4in]{images/select1.pdf}
848 \caption{{\bf Selecting a region in an alignment.}}
849 \label{select}
850 \end{center}
851 \end{figure}
852
853 \subsection{Selecting Columns}
854 To select the same residues in all sequences, click and drag along the alignment ruler.
855 This selects the entire column of the alignment. Ranges of positions from the
856 alignment ruler can also be selected by clicking on the first position and then
857 holding down the [SHIFT] key whilst clicking the other end of the selection.
858 Discontinuous regions can be selected by holding down [CTRL] and clicking on
859 positions to add to the column selection. Note that each [CTRL]-Click (PC) or
860 [CMD]-Click (Mac) changes the current selected sequence region to that column,
861 it adds to the column selection.
862 Selected columns are indicated by red highlighting in the ruler bar (Figure \ref{selectcols}).
863 %[fig 13]
864
865 \begin{figure}[htbp]
866 \begin{center}
867 \includegraphics[width=4in]{images/select2.pdf}
868 \caption{{\bf Selecting multiple columns in an alignment.} The red highlighting
869 on the alignment ruler marks the selected columns. Note that only the most
870 recently selected column has a dashed-box around it to indicate a region
871 selection. }
872 \label{selectcols}
873 \end{center}
874 \end{figure}
875
876 To select multiple complete sequences, click and drag the mouse down the
877 sequence ID panel. The same techniques can be used as for columns above ([SHIFT]-Click for continuous and [CTRL]-Click (or {\sl 
878 [CMD]-Click} for Mac) to select discontinuous
879 ranges of sequences (Figure \ref{selectrows}).
880 %[fig 14]
881
882 \subsection{Selecting Sequences}
883
884 \begin{figure}[htb]
885 \begin{center}
886 \includegraphics[width=4in]{images/select3.pdf}
887 \caption{{\bf Selecting multiple sequences in an alignment.} Use [CTRL] or
888 [SHIFT] to select many sequences at once.}
889 \label{selectrows}
890 \end{center}
891 \end{figure}
892
893
894
895 \subsection{Making Selections in Cursor Mode}
896
897 To define a selection in cursor mode (which is enabled by pressing [F2] when the alignment window is selected),
898 navigate to the top left corner of the proposed selection (using the mouse, the arrow keys, or the keystroke
899 commands described in Section \ref{cursormode}). Pressing the [Q] key marks this as the
900 corner. A red outline appears around the cursor (Figure \ref{cselect}).
901
902 Navigate to the bottom right corner of the proposed selection and press the [M] key. This marks the bottom right corner of the selection. The selection can then be treated in the same way as if it had been created in normal mode.
903
904 \begin{figure}[htbp]
905 \begin{center}
906 \includegraphics[width=1.5in]{images/csel1.pdf}
907 \includegraphics[width=1.5in]{images/csel2.pdf}
908 \includegraphics[width=1.5in]{images/csel3.pdf}
909 \includegraphics[width=1.5in]{images/csel4.pdf}
910 \caption{{\bf Making a selection in cursor mode.} Navigate to the top left
911 corner (left), press [Q], navigate to the bottom right corner and press [M] (right).}
912 \label{cselect}
913 \end{center}
914 \end{figure}
915
916 \begin{figure}
917 \begin{center}
918 \includegraphics[width=3in]{images/group1.pdf}
919 \includegraphics[width=1.5in]{images/newgroup.pdf}
920 \caption{{\bf Creating a new group from a selection.}}
921 \label{makegroup}
922 \end{center}
923 \end{figure}
924
925 \subsection{Inverting the Current Selection}
926 The current sequence or column selection can be inverted, using  {\sl Select
927 $\Rightarrow$ Invert Sequence/Column Selection} in the alignment window.
928 Inverting the selection is useful when selecting large regions in an alignment, 
929 simply select the region that is to be kept unselected, and then invert the selection.
930 This may also be useful when hiding large regions in an alignment (see Section \ref{hidingregions}).
931 Instead of selecting the columns and rows that are to be hidden, simply select the 
932 region that is to be kept
933 visible, invert the selection, then select {\sl View $\Rightarrow$ Hide
934 $\Rightarrow$ Selected Region}.
935
936 \section{Creating Groups}
937 Selections are lost as soon as a different region is selected. Groups can be
938 created which are labeled regions of the alignment. To create a group, first
939 select the region which is to comprise the group. Then click the right mouse
940 button on the selection to bring up a context menu. Select {\sl Selection
941 $\Rightarrow$ Edit New Group $\Rightarrow$ Edit name and description of
942 current group}\footnote{In earlier versions of Jalview, this entry was variously
943 `Group', `Edit Group Name', or `JGroupXXXXX' (Where XXXXX was some serial
944 number).} then enter a name for the group in the dialog box which appears.
945
946 By default the new group will have a box drawn around it. The appearance of the group can be changed (see Section \ref{colours}). 
947 This group will stay defined even when the selection is removed.
948
949
950 \section{Exporting the Current Selection}
951 The current selection can be copied to the clipboard (in PFAM format). It can
952 also be output to a textbox using the output functions in the pop-up menu
953 obtained by right clicking the current selection. The textbox enables quick
954 manual editing of the alignment prior to importing it into a new window (using
955 the {\sl New Window} button) or saving to a file with the {\sl File
956 $\Rightarrow$ Save as } pulldown menu option from the text box.
957
958 \exercise{Making Selections and Groups}{
959 \label{exselect}
960 \exstep{Load the ferredoxin alignment ({\bf PF03460} from {\bf PFAM (seed)}).
961 }
962 \exstep{Selecting an arbitrary region. Choose a residue and place the mouse
963 cursor on it (residue information will show in alignment window status
964 bar).
965 Click and drag the mouse to the bottom-right to create a selection. As you drag,
966 a red box will `rubber band' out to 
967 show the extent of the selection.
968 Release the mouse
969 button and a red box borders the selected region.
970 Press [ESC] to clear this.}
971 \exstep{ Select one sequence by clicking on
972 the sequence ID panel. Note that the sequence ID takes on a highlighted
973 background and a red box appears around the selected sequence. 
974 Hold down [SHIFT] and click another sequence ID a few positions above or below. 
975 Note how the selection expands to include all the sequences between the two positions on which you clicked.
976 Hold down [CTRL] (or [CMD] on Mac) and then click on several sequences' IDs - both selected and
977 unselected. Note how unselected IDs are individually added to the selection and previously selected IDs are 
978 individually deselected.}
979 \exstep{ Select columns by clicking on the Alignment Ruler. Note
980 that the selected column is marked with a red box.
981 Hold down [SHIFT] and click a column beyond. Note the selection expands to
982 include all the sequences between the two positions on which you clicked.}
983
984 \exstep{Enter Cursor mode using [F2], or [Fn]-F2 for Macs.
985 Navigate to column 59, row 1 by pressing {\bf 5 9 , 1 [RETURN]}.
986 Press {\bf Q} to mark this position.
987 Navigate to column 65, row 8 by pressing {\bf 6 5 , 8 [RETURN]}. Press {\bf M}
988 to complete the selection.}
989 \exstep{Note to clear the selection press the [ESC]
990 key.}
991 \exstep{To create a group from the selected the region, click the
992 right mouse button when mouse is on the selection, this opens a
993 context menu in the alignment window.
994
995 Open the {\sl Selection $\Rightarrow$ Edit New Group $\Rightarrow$ Group Colour
996 } menu and select {\sl Percentage Identity}.
997 This will turn the selected region into a group and colour it accordingly.}
998 \exstep{Hold down [CTRL] ([CMD] on Mac) or [SHIFT] and use the mouse to select and deselect sequences in
999 the alignment by clicking on their Sequence ID label. Note how the group expands
1000 to include newly selected sequences, and the Percentage Identity colouring changes. }
1001 \exstep{ Another way to resize the group is by using the mouse to click and drag
1002 the right-hand edge of the selected group.}
1003
1004 \exstep{The current selection can be exported and saved, place mouse on the text
1005 area and right clicking the mouse to open the Sequence ID context menu.
1006 Select appropriate menu option and pick an output format (eg BLC) from the
1007 {\sl Selection $\Rightarrow$ Output to Textbox \ldots} submenu.
1008 }
1009 \exstep{In the Alignment output window that opens, try manually editing the
1010 alignment before clicking the {\sl New Window} button. This opens the
1011 edited alignment in a new alignment window.} {\bf See the video at:
1012 \url{http://www.jalview.org/training/Training-Videos}.}
1013 % more? change colouring style. set border colour.
1014 }
1015
1016
1017 \section{Reordering an Alignment}
1018 Sequence reordering is simple. Highlight the sequences to be moved then press the up or down arrow keys ($\uparrow$, $\downarrow$) as appropriate (Figure \ref{reorder}). 
1019 If you wish to move a sequence up past several other sequences it is often quicker to select the group past which you want to move it and 
1020 then move the group rather than the individual sequence.
1021
1022 \begin{figure}[htbp]
1023 \begin{center}
1024 \includegraphics[width=3in]{images/move1.pdf}
1025 \includegraphics[width=3in]{images/move2.pdf}
1026 \caption{{\bf Reordering the alignment.} The selected sequence moves up one
1027 position on pressing the $\uparrow$ key.}
1028 \label{reorder}
1029 \end{center}
1030 \end{figure}
1031
1032 \exercise{Reordering the Alignment}{
1033 \label{reorderex}
1034 \exstep{Close windows.
1035
1036 Load the ferredoxin alignment ({\bf PF03460} from {\bf PFAM (seed)}).
1037 }
1038 \exstep{Select one of the sequences in the sequence ID panel, use the up and down
1039 arrow keys to alter the sequence's position in the alignment. (Note that
1040 this will not work in cursor mode)}
1041 \exstep{To select and move multiple
1042 sequences, use hold [SHIFT], and select two sequences separated by
1043 one or more un-selected sequences, repeat using the [CTRL] key. Note how
1044 multiple sequences are grouped together when they are re-ordered using the up and down arrow keys.}
1045 {\bf See the video at: \url{http://www.jalview.org/training/Training-Videos}.}
1046 }
1047
1048
1049 \section{Hiding Regions}
1050 \label{hidingregions}
1051 It is sometimes convenient to exclude some sequences or residues in the alignment without actually deleting them. 
1052 Jalview allows sequences or alignment columns within a view to be hidden, and this facility has been used to create 
1053 the several different views in the example alignment file that is loaded when Jalview is first started (see Figure \ref{startpage}).
1054
1055 To hide a set of sequences, select them and right-click the mouse on the
1056 selected sequence IDs to bring up the context pop-up menu. Select {\sl Hide
1057 Sequences} and the sequences will be concealed, with a small blue triangle indicating their position (Figure \ref{hideseq}). 
1058 To unhide (reveal) the sequences, right click on the triangle and select {\sl Reveal Sequences} from the context menu.
1059
1060
1061  \begin{figure}[htbp]
1062 \begin{center}
1063 \includegraphics[width=1.9in]{images/hide1.pdf}
1064 \includegraphics[width=2.7in]{images/hide2.pdf}
1065 \includegraphics[width=1.8in]{images/hide3.pdf}
1066 \caption{{\bf Hiding Sequences} Hidden sequences are represented by a small
1067 blue triangle in the sequence ID panel.}
1068 \label{hideseq}
1069 \end{center}
1070 \end{figure}
1071
1072 A similar mechanism applies to columns (Figure \ref{hidecol}). Selected columns
1073 (indicated by a red marker) can be hidden and revealed in the same way {\sl via}
1074 the context pop-up menu by right clicking on the ruler bar. The hidden column
1075 selection is indicated by a small blue triangle in the ruler bar.
1076
1077  \begin{figure}[htbp]
1078 \begin{center}
1079 \includegraphics[width=1.7in]{images/hide4.pdf}
1080 \includegraphics[width=3in]{images/hide5.pdf}
1081 \includegraphics[width=1.2in]{images/hide6.pdf}
1082 \caption{{\bf Hiding Columns} Hidden columns are represented by a small blue
1083 triangle in the ruler bar.}
1084 \label{hidecol}
1085 \end{center}
1086 \end{figure}
1087
1088 It is often easier to select the region that you intend to work with, rather
1089 than the regions that you want to hide. In this case, select the required region and use the {\sl View $\Rightarrow$ Hide
1090 $\Rightarrow$ All but Selected Region } menu entry, or press [SHIFT]-[CTRL]-H
1091 to hide the unselected region.
1092
1093 \subsection{Representing a Group with a Single Sequence}
1094
1095 Instead of hiding a group completely, it is sometimes useful to work with just one representative sequence. 
1096 The {\sl $<$Sequence ID$>$ $\Rightarrow$ Represent group with $<$Sequence ID$>$ } option from the sequence ID pop-up menu enables this variant 
1097 of the hidden groups function. The remaining representative sequence can be visualized and manipulated like any other. 
1098 Note, any alignment edits that affect the sequence will also affect the whole
1099 sequence group.
1100
1101
1102 \begin{figure}[htb]
1103 \begin{center}
1104 \includegraphics[width=3in]{images/edit1.pdf}
1105 \includegraphics[width=3in]{images/edit2.pdf}
1106 \caption{{\bf Introducing gaps in a single sequence.} Gaps are introduced as the
1107 selected sequence is dragged to the right while pressing and holding [SHIFT].}
1108 \label{gapseq}
1109 \end{center}
1110 \end{figure}
1111
1112 \begin{figure}[htb]
1113 \begin{center}
1114 \includegraphics[width=3in]{images/edit3.pdf}
1115 \includegraphics[width=3in]{images/edit4.pdf}
1116 \caption{{\bf Introducing gaps in a group.} Gaps are introduced as the selected
1117 group is dragged to the right with [CTRL] pressed.}
1118 \label{gapgroup}
1119 \end{center}
1120 \end{figure}
1121
1122 %% TODO introduce select/hide by annotation here
1123 %% favor coverage of these core interactions (hide, show, select, reorder, multiple view)
1124 \exercise{Hiding and Revealing Regions}{
1125 \label{hidingex}
1126 \exstep{Load the ferredoxin alignment ({\bf PF03460} from {\bf PFAM (seed)}).
1127 }
1128 \exstep{Select a contiguous set of sequences by clicking and dragging on the sequence ID panel.
1129 Right click on the selected sequence IDs to bring up the sequence ID context
1130 menu, select {\sl Hide Sequences}.
1131 }
1132 \exstep{
1133 Right click on the blue triangle indicating hidden sequences and select {\sl
1134 Reveal Sequences} in the panel. (If you have hidden all sequences then you will
1135 need to use the alignment window menu option {\sl View $\Rightarrow$ Show $\Rightarrow$ 
1136 All Sequences.}) }
1137 \exstep{
1138 Repeat the process but use a non-contiguous set of sequences using the [CTRL] ([CMD] on Mac) key. Note that when
1139 multiple regions are hidden you can select either {\sl
1140 Reveal Sequences} to reveal the hidden sequences that were clicked, or {\sl
1141 Reveal All}.
1142 }
1143 \exstep{Repeat the above using columns to hide and reveal columns
1144 instead of sequences.}
1145 \exstep{Select a region of the alignment, and experiment with the {\sl Hide all
1146 but selected region} option. In the alignment window menu, {\sl View $\Rightarrow$ Hide $\Rightarrow$ All
1147 but selected region.}} \exstep{Select some sequences, pick one to represent the rest by hovering
1148 the mouse over this sequence. Bring up the Sequence ID context menu by right
1149 clicking and select {\sl (Sequence ID name) $\Rightarrow$ Represent group
1150 with (Sequence ID name )}. To reveal these hidden sequences, right click on the
1151 Sequence ID and in the context menu select {\sl Reveal All}.}
1152 {\bf See the video at:  \url{http://www.jalview.org/training/Training-Videos}.}
1153 }
1154
1155
1156
1157 \section{Introducing and Removing Gaps}
1158 The alignment view provides an interactive editing interface, allowing gaps to be inserted or deleted to the left of any position
1159 in a sequence or sequence group. Alignment editing can only be performed whilst in keyboard editing mode (entered by pressing [F2])
1160  or by clicking and dragging residues with the mouse when [SHIFT], [CTRL] or [CMD] (Mac) is held down (which differs from earlier versions of Jalview).
1161
1162
1163 \subsection{Undoing Edits}
1164 Alignment edits can be undone {\sl via} the {\sl Edit $\Rightarrow$ Undo Edit}
1165 alignment window menu option, or [CTRL]-Z. An edit, if undone, may be re-applied
1166 with {\sl Edit $\Rightarrow$ Redo Edit}, or [CTRL]-Y. Note, however, that the
1167 {\sl Undo} function only works for edits to the alignment or sequence ordering.
1168 Colouring of the alignment, showing and hiding of sequences or modification of
1169 annotation that only affect the alignment's display cannot
1170 be undone.
1171
1172 \subsection{Locked Editing}
1173 \label{lockededits}
1174 The Jalview alignment editing model is different to that used in other alignment
1175 editors. Because edits are restricted to the insertion and deletion of gaps to the left of a particular sequence position, 
1176 editing has the effect of shifting the rest of the sequence(s) being edited down or up-stream with respect to the rest of 
1177 alignment. The {\sl Edit $\Rightarrow$ Pad Gaps} option can be enabled to eliminate `ragged edges' at the end of the alignment, 
1178 but does not avoid the `knock-on' effect which is sometimes undesirable. 
1179 However, its effect can be limited by performing the edit within a selected region. 
1180 In this case, gaps will only be removed or inserted within the selected region. 
1181 Edits are similarly constrained when they occur adjacent to a hidden column.
1182
1183 \subsection{Introducing Gaps in a Single Sequence}
1184 To introduce a gap, first select the sequence in the sequence ID panel and
1185 then place the cursor on the residue to the immediate right of where the gap
1186 should appear. Hold down the [SHIFT] key and the left mouse button, then drag the sequence to the right until the required number of gaps 
1187 has been inserted.
1188
1189 One common error is to forget to hold down [SHIFT]. This results in a selection which is one sequence high and one residue long. 
1190 Gaps cannot be inserted in such a selection. The selection can be cleared and editing enabled by pressing the [ESC] key.
1191
1192 \subsection{Introducing Gaps in all Sequences of a Group}
1193 To insert gaps in all sequences in a selection or group, select the
1194 required sequences in the sequence ID panel and then place the mouse cursor on
1195 any residue in the selection or group to the immediate right of the position in which a gap should appear. Hold down the [CTRL] key 
1196 and the left mouse button, then drag the sequences to the right until the required number of gaps has appeared.
1197
1198 Gaps can be removed by dragging the residue to the immediate right of the gap
1199 leftwards whilst holding down [SHIFT] (for single sequences) or [CTRL] (for a group of sequences).
1200
1201 \subsection{Sliding Sequences}
1202 Pressing the [$\leftarrow$] or [$\rightarrow$] arrow keys when one or more
1203 sequences are selected will ``slide'' the entire selected sequences to the left
1204 or right (respectively). Slides occur regardless of the region selection -
1205 which, for example, allows you to easily reposition misaligned subfamilies
1206 within a larger alignment.
1207 % % better idea to introduce hiding sequences, and use the invert selection, hide
1208 % others, to simplify manual alignment construction
1209
1210
1211
1212 \subsection{Editing in Cursor Mode}
1213 Gaps can be easily inserted when in cursor mode (toggled with [F2]) by
1214 pressing [SPACE]. Gaps will be inserted at the cursor, shifting the residue
1215 under the cursor to the right. To insert {\sl n} gaps type {\sl n} and then
1216 press [SPACE]. To insert gaps into all sequences of a group, use [CTRL]-[SPACE]
1217 or [SHIFT]-[SPACE] (both keys held down together).
1218
1219 Gaps can be removed in cursor mode by pressing [BACKSPACE]. First make sure you
1220 have everything unselected by pressing [ESC]. The gap under the cursor will be
1221 removed. To remove {\sl n} gaps, type {\sl n} and then press [BACKSPACE]. Gaps
1222 will be deleted up to the number specified. To delete gaps from all sequences of
1223 a group, press [CTRL]-[BACKSPACE] or [SHIFT]-[BACKSPACE] (both keys held down
1224 together). Note that the deletion will only occur if the gaps are in the same
1225 columns in all sequences in the selected group, and those columns are to the
1226 right of the selected residue.
1227
1228
1229 \exercise{Editing Alignments Homework Exercise}
1230   %\label{mousealedit}
1231 % TODO: VERIFY FOR 2.6.1 and 2.7 - NUMBERING/INSTRUCTIONS APPEAR OFF
1232 {
1233 \label{editingalignex}
1234 You are going to manually reconstruct part of the example Jalview
1235 alignment available at
1236  \href{http://www.jalview.org/examples/exampleFile.jvp}
1237  {http://www.jalview.org/examples/exampleFile.jvp}.
1238
1239 {\sl {\bf Mac Users:} Please use the Apple or [CMD] key in place of [CTRL]
1240 for key combinations such as [CTRL]-A. }
1241
1242 Remember to use [CTRL]-Z to undo an edit, or the {\sl File $\Rightarrow$
1243  Reload } function to revert the alignment back to the original version if you
1244  want to start again.
1245
1246 \exstep{ Load the URL
1247 \textsf{http://www.jalview.org/tutorial/unaligned.fa} which contains part of the
1248 ferredoxin alignment from PF03460.}
1249
1250 \exstep{ Select the first 7 sequences, and press H key to hide them (or right click
1251 on the sequence IDs to open the sequence ID context menu, and select {\sl Hide
1252 Sequences}).}
1253
1254 \exstep{ Select FER3\_RAPSA and FER\_BRANA. Slide the sequences to
1255 the right so the initial residue A lies at column 57 using the $\rightarrow$
1256 key.}
1257
1258 \exstep{ Select FER1\_SPIOL, FER1\_ARATH, FER2\_ARATH, Q93Z60\_ARATH and
1259 O80429\_MAIZE
1260
1261 {\sl Hint: you can do this by pressing [CTRL]-I to invert the sequence selection and then
1262 deselect FER1\_MAIZE), and use the $\rightarrow$ key to slide them to so they
1263 begin at column 5 of the alignment view.}} 
1264
1265 \exstep{ Select all the visible
1266 sequences (those not hidden) in the block by pressing [CTRL]-A.
1267 Insert a single
1268 gap in all selected sequences at column 38 of the alignment by holding [CTRL]
1269 and clicking on the residue R at column 38 in the FER1\_SPIOL, then drag one
1270 column to right.
1271 Insert another gap at column 47 in all sequences in the same way.}
1272
1273 \exstep{ Correct the ferredoxin domain alignment for FER1\_SPIOL by
1274 inserting two additional gaps after the gap at column 47. First press [ESC] to
1275 clear the selection, then hold [SHIFT] and click and drag on the G and move it
1276 two columns to the right.}
1277
1278 \exstep{ Now complete the
1279 alignment of FER1\_SPIOL with a locked edit by pressing [ESC] and select
1280 columns 47 to 57 of the FER1\_SPIOL row. Move the mouse onto the G at column 50,
1281 hold [SHIFT] and drag the G in column 47 of FER1\_SPIOL to the left by one
1282 column to insert a gap at column 57.}
1283
1284 \exstep{ In the next two steps you will complete the alignment of the last two 
1285 sequences.
1286
1287 Select the last two sequences (FER1\_MAIZE and O80429\_MAIZE), then press [SHIFT]
1288 and click and drag the initial methionine of O80429\_MAIZE 5 columns to the right
1289 so it lies at column 10.
1290
1291 Keep holding [SHIFT] and click and drag to insert
1292 another gap at the proline at column 25 (25C in cursor mode). Remove the gap at
1293 column 44, and insert 4 gaps at column 47 (after AAPM).}
1294
1295 \exstep{ Hold [SHIFT] and drag the I at column 39 of FER1\_MAIZE 2 columns to the
1296 right. Remove the gap at FER1\_MAIZE column 49 by [SHIFT]-click and drag left by
1297 one column. Press [ESC] to clear the selection, and then insert three gaps in
1298 FER1\_MAIZE at column 47 by holding [SHIFT] and click and drag the S in FER1\_MAIZE to the right by three columns. Finally,
1299 remove the gap in O80429\_MAIZE at column 56 using [SHIFT]-drag to the left on
1300 56C.}
1301
1302 \exstep{ Use the
1303 {\sl Edit $\Rightarrow$ Undo Edit} and {\sl Edit $\Rightarrow$ Redo Edit} menu
1304 option, or their keyboard shortcuts ([CTRL]-Z and [CTRL]-Y) to step 
1305 backwards and replay the edits you have made.}
1306 }
1307
1308
1309 \exercise{Keyboard Edits Homework Exercise}
1310 {
1311 \label{keyboardsex}
1312 This continues on from the previous exercise, and recreates the final part of the example ferredoxin
1313 alignment from the unaligned sequences using Jalview's keyboard editing mode.
1314
1315 {\bf Window users:} Please {\em only use} [SHIFT]-[SPACE] in this
1316 exercise.
1317
1318 {\bf Mac users:} [CTRL]-[SPACE] can also be used instead of [SHIFT]-[SPACE].
1319
1320 \exstep{Load the sequence alignment at
1321 \textsf{http://www.jalview.org/tutorial/unaligned.fa}, or continue using the
1322 edited alignment.  If you continue from the
1323 previous exercise, first right click on the sequence ID panel and select
1324 {\sl Reveal All}. Enter cursor mode by pressing [F2] (or [Fn]-[F2] (Mac)).}
1325 % TODO: BACKSPACE or DELETE WHEN SEQS ARE SELECTED WILL DELETE ALL SEQS JAL-783
1326
1327 \exstep{Insert 58 gaps at the start of the sequence 1 (FER\_CAPAA). Press
1328 {\sl 58} then {\sl [SPACE]}. }
1329
1330 \exstep{Go down one sequence and select rows 2-5 as a block. Click on the second sequence ID (FER\_CAPAN).
1331  Hold down shift and click on the fifth (FER1\_PEA). }
1332
1333 \exstep{Insert 6 gaps at the start of this group. Go to column 1 row 2 by typing
1334 {\sl 1,2} then press {\sl [RETURN]}. Now insert 6 gaps in all the sequences.
1335 Type {\sl 6} then hold down {\sl [SHIFT]} and press {\sl [SPACE]}.}
1336 \exstep{Now insert one gap at column 34 and another at 38. Insert 3 gaps at 47.
1337 Press {\sl 34C} then {\sl [SHIFT]-[SPACE]}.  Press {\sl 38C} then
1338 [SHIFT]-[SPACE].
1339 Press {\sl 47C} then {\sl 3 [SHIFT-SPACE]} the first through fourth sequences
1340 are now aligned.}
1341 \exstep{The fifth sequence (FER1\_PEA) is poorly aligned. We will delete some gaps and add some new ones. Press {\sl [ESC]} to clear the selection. Navigate to the start of sequence 5 and delete 3 gaps. Press {\sl 1,5 [RETURN]} then {\sl 3 [BACKSPACE]} to delete three gaps. Go to column 31 and delete the gap. Press {\sl 31C [BACKSPACE]} .}
1342 \exstep{ Similarly delete the gap now at column 34, then insert two gaps at
1343 column 38.
1344 Press {\sl 34C [BACKSPACE]  38C 2 [SPACE]}. Delete three gaps at column 44 and
1345 insert one at column 47 by pressing {\sl 44C 3 [BACKSPACE] 47C [SPACE]}.  The top five sequences are 
1346 now aligned.}}
1347
1348
1349 \chapter{Colouring Sequences and Figure Generation}
1350 \label{colouringfigures}
1351 \section{Colouring Sequences}
1352 \label{colours}
1353
1354 Colouring sequences is a key aspect of alignment presentation. Jalview allows
1355 you to colour the whole alignment, or just specific groups. Alignment and
1356 group colours are rendered
1357 {\bf below} any other colours, such as those arising from sequence features
1358 (these are described in Section \ref{featannot}). This means that if you
1359 try to apply one of the colourschemes described in this section, and nothing
1360 appears to happen, it may be that you have sequence feature annotation
1361 displayed, and you may have to disable it using the {\sl View $\Rightarrow$
1362 Show Sequence Features} option before you can see your colourscheme.
1363
1364 There are two main types of colouring styles: {\bf simple static residue}
1365 colourschemes and {\bf dynamic schemes} which use conservation and consensus
1366 analysis to control colouring. {\bf Hybrid colouring} is also possible, where
1367 static residue schemes are modified using a dynamic scheme. The individual schemes are described in Section \ref{colscheme}.
1368
1369 \subsection{Colouring the Whole Alignment}
1370
1371 \parbox[c]{3.75in}{The alignment can be coloured {\sl via} the {\sl Colour} menu option in the alignment window. Selecting the colour scheme causes all residues to be coloured. The menu is divided into three sections. The first section gives options for the behaviour of the menu options, the second lists static and dynamic colourschemes available for selection. The last gives options for making hybrid colourschemes using conservation shading or colourscheme thresholding. 
1372
1373 }\parbox[c]{3in}{
1374 \centerline {
1375 \includegraphics[width=2.5in]{images/colour2.pdf}
1376 }
1377 }
1378
1379 \subsection{Colouring a Group or Selection}
1380
1381 Selections or groups can be coloured in two ways. The first is {\sl via} the Alignment Window's {\sl Colour} menu as stated above,
1382  after first ensuring that the {\sl Apply Colour To All Groups} flag is {\bf
1383  not} selected.
1384  This must be turned {\bf off} specifically as it is {\bf on} by default. 
1385  When unticked, selections from the Colours menu will only change the colour for residues in the current selection, 
1386  or the alignment view's ``background colourscheme'' when no selection exists.
1387
1388 The second method is to select sequences and right click mouse to open pop-up
1389 menu and select {\sl Selection $\Rightarrow$ Edit New Group $\Rightarrow$ Group
1390 Colour} from context menu options
1391 (Figure \ref{colgrp}). This only changes the colour of the current selection or group.
1392
1393 \begin{figure}[htbp]
1394 \begin{center}
1395 %TODO update group_col.pdf to show latest jalview group edit submenu
1396 \includegraphics[width=4in]{images/group_col.pdf}
1397 \caption{{\bf Colouring a group via the context menu.}}
1398 \label{colgrp}
1399 \end{center}
1400 \end{figure}
1401
1402 \subsection{Shading by Conservation}
1403 For many colour schemes, the intensity of the colour in a column can be scaled
1404 by the degree of amino acid property conservation. Selecting {\sl Colour
1405 $\Rightarrow$ By Conservation} enables this mode, and {\sl Modify
1406 Conservation Threshold...} brings up a selection box (the {\sl Conservation
1407 Colour Increment} dialog box) allowing the alignment colouring to be modified.
1408 Selecting a higher value limits colouring to more highly conserved columns (Figure \ref{colcons}).
1409
1410  \begin{figure}[htbp]
1411 \begin{center}
1412 \includegraphics[width=2in]{images/colourcons1.pdf}
1413 \includegraphics[width=2in]{images/colourcons3.pdf}
1414 \includegraphics[width=2in]{images/colourcons5.pdf}
1415 \caption{{\bf Conservation Shading} The density of the ClustalX style residue
1416 colouring is controlled by the conservation threshold. The effect of 0\% (left), 50\% (center) and 100\% (right) thresholds are shown.
1417 }
1418 \label{colcons}
1419 \end{center}
1420 \end{figure}
1421
1422 \subsection{Thresholding by Percentage Identity}
1423
1424 `Thresholding' is another hybrid colour model where a residue is only coloured
1425 if it is not excluded by an applied threshold. Selecting {\sl Colour $\Rightarrow$ Above Identity Threshold} brings up a selection box with a slider controlling the minimum percentage identity threshold to be applied. Selecting a higher threshold (by sliding to the right) limits the colouring to columns with a higher percentage identity (as shown by the Consensus histogram in the annotation panel).
1426
1427 \subsection{Colouring by Annotation}
1428 \label{colourbyannotation}
1429 \parbox[c]{3.2in}{
1430 Any of the {\bf quantitative} annotations shown on an alignment can be used to
1431 threshold or shade the whole alignment.\footnote{Please remember to turn off
1432 Sequence Feature display to see the shading} 
1433
1434 The {\sl Colour $\Rightarrow$ By
1435 Annotation} option opens a dialog which allows you to select which annotation
1436 to use, the minimum and maximum shading colours or whether the original
1437 colouring should be thresholded (the `Use original colours' option).
1438
1439 Default settings for minimum and maximum colours can be set in the Jalview
1440 Desktop's preferences.  
1441 }\parbox[c]{3in}{
1442 \centerline{\includegraphics[width=2.8in]{images/col_byannot.pdf}}}
1443
1444 The {\bf per Sequence} option in the {\bf Colour By Annotation} dialog
1445 allows each sequence to be shaded according to sequence associated annotation
1446 rows, such as protein disorder scores. This functionality is described further
1447 in Section \ref{protdisorderpred}.
1448
1449 \subsection{Colour Schemes} 
1450
1451 \label{colscheme}
1452 Full details on each colour scheme can be found in the Jalview on-line help. A brief description of each one is provided below:
1453
1454 \subsubsection{Clustalx}
1455
1456
1457  \parbox[c]{3.5in}{This is an emulation of the default colourscheme used for alignments in ClustalX, a graphical interface for the ClustalW multiple sequence alignment program. Each residue in the alignment is assigned a colour if the amino acid profile of the alignment at that position meets some minimum criteria specific for the residue type. }
1458 \parbox[c]{3in}{\includegraphics[width=2.75in]{images/col_clustalx.pdf}}
1459
1460 \subsubsection{Blosum62 Score}
1461
1462 \parbox[c]{3.5in}{Gaps are coloured white. If a residue matches the consensus sequence residue at that position it is coloured dark blue. If it does not match the consensus residue but the Blosum62 matrix gives a positive score, it is coloured light blue.}
1463 \parbox[c]{3in}{
1464 \includegraphics[width=2.75in]{images/col_blosum62.pdf}
1465 }
1466
1467 \subsubsection{Percentage Identity}
1468 \parbox[c]{3.5in}{
1469 The Percentage Identity option colours the residues (boxes and/or text) according to the percentage of the residues in each column that agree with the consensus sequence. Only the residues that agree with the consensus residue for each column are coloured.
1470 }
1471 \parbox[c]{3in}{
1472 \includegraphics[width=2.75in]{images/col_percent.pdf}
1473 }
1474
1475 \subsubsection{Zappo}
1476 \parbox[c]{3.5in}{
1477 The residues are coloured according to their physicochemical properties. The physicochemical groupings are Aliphatic/hydrophobic, Aromatic, 
1478 Positive, Negative, Hydrophillic, Conformationally special, and Cyst(e)ine.
1479 }
1480 \parbox[c]{3in}{
1481 \includegraphics[width=2.75in]{images/col_zappo.pdf}
1482 }
1483
1484 \subsubsection{Taylor}
1485
1486 \parbox[c]{3.5in}{
1487 This colour scheme was devised by Willie Taylor and an entertaining description of its origin can be found in Protein Engineering, 
1488 Vol 10 , 743-746 (1997).
1489 }
1490 \parbox[c]{3in}{
1491 \includegraphics[width=2.75in]{images/col_taylor.pdf}
1492 }
1493
1494 \subsubsection{Hydrophobicity}
1495 \parbox[c]{3.5in}{
1496 Residues are coloured according to the hydrophobicity table of Kyte, J., and Doolittle, R.F., J. Mol. Biol. 1157, 105-132, 1982. The most hydrophobic residues are coloured red and the most hydrophilic ones are coloured blue.
1497 }
1498 \parbox[c]{3in}{
1499 \includegraphics[width=2.75in]{images/col_hydro.pdf}
1500 }
1501
1502 \subsubsection{Helix Propensity}
1503
1504 \parbox[c]{3.5in}{
1505 The residues are coloured according to their Chou-Fasman\footnote{\label{chou-fasman}Chou, PY and Fasman, GD. Annu Rev Biochem. 1978;47:251-76.} helix propensity. The highest propensity is magenta, the lowest is green.
1506 }
1507 \parbox[c]{3in}{
1508 \includegraphics[width=2.75in]{images/col_helix.pdf}
1509 }
1510
1511 \subsubsection{Strand Propensity}
1512
1513 \parbox[c]{3.5in}{
1514 The residues are coloured according to their Chou-Fasman\textsuperscript{\ref{chou-fasman}} Strand propensity. The highest propensity is Yellow, the lowest is blue.
1515 }
1516 \parbox[c]{3in}{
1517 \includegraphics[width=2.75in]{images/col_strand.pdf}
1518 }
1519
1520
1521
1522 \subsubsection{Turn Propensity}
1523 \parbox[c]{3.5in}{
1524 The residues are coloured according to their Chou-Fasman\textsuperscript{\ref{chou-fasman}} turn propensity. The highest propensity is red, the lowest is cyan.
1525 }
1526 \parbox[c]{3in}{
1527 \includegraphics[width=2.75in]{images/col_turn.pdf}
1528 }
1529
1530 \subsubsection{Buried Index}
1531 \parbox[c]{3.5in}{
1532 The residues are coloured according to their Chou-Fasman\textsuperscript{\ref{chou-fasman}} burial propensity. The highest propensity is blue, the lowest is green.
1533 }
1534 \parbox[c]{3in}{
1535 \includegraphics[width=2.75in]{images/col_buried.pdf}
1536 }
1537  
1538
1539 \subsubsection{Nucleotide}
1540 \parbox[c]{3.5in}{ Residues are coloured with four colours corresponding to the
1541 four nucleotide bases. All non ACTG residues are uncoloured. See Section
1542 \ref{workingwithnuc} for further information about working with nucleic acid
1543 sequences and alignments.
1544 } \parbox[c]{3in}{ \includegraphics[width=2.75in]{images/col_nuc.pdf} }
1545
1546 \subsubsection{Purine/Pyrimidine}
1547 \parbox[c]{3.5in}{ Residues are coloured according to whether the corresponding
1548 nucleotide bases are purine (magenta) or pyrimidine (cyan) based. All non ACTG
1549 residues are uncoloured. For further information about working with nucleic acid
1550 sequences and alignments, see Section \ref{workingwithnuc}.
1551 %and Section \ref{workingwithrna}
1552
1553 } \parbox[c]{3in}{ \includegraphics[width=2.75in]{images/col_purpyr.pdf} }
1554
1555 \subsubsection{By RNA Helices}
1556 \parbox[c]{3.5in}{ Columns are coloured according to their assigned RNA helix as
1557 defined by a secondary structure annotation line on the alignment. Colours for
1558 each helix are randomly assigned, and option only available when an RNA
1559 secondary structure row is present on the alignment. 
1560 % For more details see Section \ref{workingwithrna} 
1561 } \parbox[c]{3in}{
1562 \includegraphics[width=2.75in]{images/col_rnahelix.pdf} }
1563
1564 \subsubsection{User Defined}
1565 This dialog allows the user to create any number of named colour schemes at
1566 will. Any residue may be assigned any colour. The colour scheme can then be
1567 named. If you save the colour scheme, this name will appear on the Colour menu
1568 (Figure \ref{usercol}).
1569
1570
1571 \begin{figure}[htbp]
1572 \begin{center}
1573 \includegraphics[width=2.1in]{images/col_user1.pdf}
1574 \includegraphics[width=2in]{images/col_user2.pdf}
1575 \includegraphics[width=2.1in]{images/col_user3.pdf}
1576 \caption{{\bf Creation of a user defined colour scheme.} Residue types are
1577 assigned colours (left). The profile is saved (center) and can then be accessed {\sl via} the {\sl Colour} menu (right).}
1578 \label{usercol}
1579 \end{center}
1580 \end{figure}
1581
1582 \exercise{Colouring Alignments}{
1583 \label{color}
1584 Note: Ensure that the {\sl Apply Colour
1585 To All Groups} flag is not selected (ie unticked) in {\sl Colour} menu in the alignment window.
1586 % patch needed for 2.10 This must be turned {\sl off} specifically as it is on
1587 % by default.
1588
1589 \exstep{Open a sequence alignment, for example the PFAM domain PF03460 in PFAM
1590 seed database. Select the alignment menu option {\sl Colour $\Rightarrow$
1591 Clustalx} and note the colour change. Now try all the other colour schemes in the {\sl Colour} menu. 
1592 Note that some colour schemes do not colour all residues.}
1593 \exstep{Colour the alignment using {\sl Colour  $\Rightarrow$ Blosum62 score}. Select a group
1594 of around 4 similar sequences. Use the context menu (right click on the residues in the group)
1595 option {\sl Selection $\Rightarrow$ Edit New Group $\Rightarrow$ Group Colour
1596 $\Rightarrow$ Blosum62 score} to colour the selection. Notice how some residues which
1597 were not coloured are now coloured. The calculations performed for dynamic
1598 colouring schemes like Blosum62 are based on the selected group,
1599 not the whole alignment. (This also explains the colouring changes observed in exercise
1600 \ref{exselect} during the group selection step).}
1601 \exstep{Keeping the same selection as before, colour the complete alignment except
1602 the group using {\sl Colour  $\Rightarrow$ Taylor}.
1603 Select the menu option  {\sl Colour  $\Rightarrow$ By Conservation}. 
1604 Slide the selector in the Conservation Colour Increment dialog box from side
1605 to side and observe the changes in the alignment colouring in the selection and in the complete alignment.}
1606 Note: Feature colours overlay residue colouring, and this may mask residue colouring. If this is an issue, he features colours can be
1607 toggled off by going to {\sl View  $\Rightarrow$ Show Sequence Features}.
1608
1609 {\bf See the video at: \url{http://www.jalview.org/training/Training-Videos}.}
1610 }
1611
1612
1613 \exercise{User Defined Colour Schemes}{
1614 \label{colouex}
1615 \exstep{Load a sequence alignment PF03460 from the PFAM
1616 seed database. Ensure that the {\sl Colour  $\Rightarrow$
1617 None} is selected. Select the alignment menu option {\sl Colour $\Rightarrow$
1618 User Defined}.
1619 A dialog window will open.}
1620 \exstep{Click on an amino acid button, then select a colour for that amino acid. Repeat till all amino acids are coloured to your liking.}
1621 \exstep{ Insert a name for the colourscheme in the appropriate field and click {\sl Save Scheme}. You will be prompted for a file name in which to save the colour scheme. The dialog window can now be closed.}
1622 \exstep{The new colour scheme appears in the list of colour schemes in the {\sl Colour} menu and can be selected in future Jalview sessions.
1623
1624 {\bf See the video at:
1625 \url{http://www.jalview.org/training/Training-Videos}.}} }
1626
1627 \exercise{Alignment Layout}{
1628 \label{exscreen}
1629 \exstep{Start Jalview and open the URL \textsf{http://www.jalview.org/examples/exampleFile.jvp}. 
1630 Select {\sl Format $\Rightarrow$ Wrap} from the alignment window menu. 
1631 Experiment with the various options from the {\sl Format} menu, for example adjust the ruler placement, 
1632 sequence ID format and so on. }
1633 \exstep{Hide all the annotation rows by toggling {\sl Annotations $\Rightarrow$
1634 Show Annotations} from the alignment window menu. Reveal the annotations by selecting the same menu option.}
1635 \exstep{Deselect {\sl Format $\Rightarrow$ Wrap}.}
1636 \exstep{Right click on the
1637 annotation row labels to bring up the context menu, then select {\sl
1638 Hide This Row}. Bring up the context menu again and select {\sl
1639 Show All Hidden Rows} to reveal them.}
1640 \exstep{Annotations can be reordered by clicking on the annotations name and
1641 dragging the row to the desired position. Click on the {\sl Consensus} row and drag it upwards to just above {\sl Quality}. 
1642 The rows should now be reordered. Features and annotations are covered in more detail in Section \ref{featannot}.}
1643 \exstep{Move the mouse to the top left hand corner of the annotation labels - 
1644 a up/down arrow symbol should appear - click on the icon, the height of the {\sl Annotation Area} can be changed 
1645 by clicking and dragging this icon up or down.}
1646 \bf See the video at:
1647 \url{http://www.jalview.org/training/Training-Videos}.}
1648
1649 \section{Formatting and Graphics Output}
1650 \label{layoutandoutput}
1651 Jalview is a WYSIWIG alignment editor. This means that for most kinds of graphics output, 
1652 the layout that is seen on screen will be the same as what is outputted in an
1653 exported graphics file.
1654 It is therefore important to pick the right kind of display layout prior to generating figures. 
1655
1656 \subsection{Multiple Alignment Views}
1657
1658 Jalview is able to create multiple independent visualizations of the same underlying alignment - these are called {\bf Views}. 
1659 Because each view displays the same underlying data, any edits performed in one view will update the alignment or annotation visible in all views.
1660
1661 \parbox[c]{4in}{Alignment views are created using the {\sl View $\Rightarrow$
1662 New View} option of the alignment window or by pressing [CTRL]-T.
1663 This will create a new view with the same groups, alignment layout and display options as the current one. 
1664 Pressing G key will gather together Views as named tabs on the alignment window, and pressing X key will expand gathered Views so they can be viewed 
1665 simultaneously in their own separate windows.} \parbox[c]{2.75in}{
1666 \begin{center}\centerline{
1667 \includegraphics[width=2.5in]{images/mulv_tabs.pdf}}
1668 \end{center}
1669 }
1670
1671 To delete a view, press [CTRL]-W (or [CMD]-W (Mac)).
1672 To rename a view, right click the view's name, this open the Enter View Name dialogue box, enter the desired name.
1673 % JBPNote make an excercise on views ?
1674
1675 \subsection{Alignment Layout}
1676 Jalview provides two screen layout modes, unwrapped (the default) where the alignment is in one long line across the window, and wrapped, 
1677 where the alignment is on multiple lines, each the width of the window. Most layout options are controlled by the Format menu option in the 
1678 alignment window, and control the overall look of the alignment in the view (rather than just a selected region).
1679
1680 \subsubsection{Wrapped Alignments}
1681 Wrapped alignments can be toggled on and off using the {\sl Format $\Rightarrow$ Wrap} menu option (Figure \ref{wrap}). Note that 
1682 the annotation tracks are also wrapped. Wrapped alignments are great for publications and presentations but are of limited use when 
1683 working with large numbers of sequences. 
1684
1685 If annotations are not all visible in wrapped mode, expand the alignment window to view them. Note that alignment annotation 
1686 (see Section \ref{featannot}) cannot be interactively created or edited in wrapped mode, and selection of large regions is difficult. 
1687 \begin{figure}[htbp]
1688 \begin{center}
1689 \parbox[c]{2in}{\includegraphics[width=2in]{images/wrap1.pdf}}
1690 \parbox[c]{4in}{\includegraphics[width=4in]{images/wrap2.pdf}}
1691 \caption{{\bf Wrapping the alignment.}}
1692 \label{wrap}
1693 \end{center}
1694 \end{figure}
1695
1696
1697 \subsubsection{Fonts}
1698
1699 \parbox[c]{4in}{The text appearance in a view can be modified {\sl via} the {\sl Format $\Rightarrow$ Font\ldots} alignment window menu. This setting 
1700 applies for all alignment and annotation text except for that displayed in tool-tips. Additionally, font size and spacing can be adjusted rapidly by 
1701 clicking the middle mouse button and dragging across the alignment window.}
1702 \parbox[c]{2in}{\centerline{\includegraphics[width=1.75in]{images/font.pdf}}}
1703
1704 \subsubsection{Numbering and Label Justification}
1705 Options in the {\sl Format} menu are provided to control the alignment view, and provide a range of options to control the display of sequence and 
1706 alignment numbering, the justification of sequence IDs and annotation row column labels on the annotation rows shown below the alignment.
1707
1708 \subsubsection{Alignment and Group Colouring and Appearance}
1709 The display of hidden row/column markers and gap characters can be turned off with {\sl Format $\Rightarrow$ Show Hidden Markers} and 
1710 {\sl Format $\Rightarrow$ Show Gaps}, respectively. The {\sl Text} and {\sl Colour Text} option controls the display of sequence 
1711 text and the application of alignment and group colouring to it. {\sl Boxes } controls the display of the background area 
1712 behind each residue that is coloured by the applied colourscheme.  
1713
1714 \subsubsection{Highlighting Nonconserved Symbols}
1715 The alignment layout and group sub-menu both contain an option to hide
1716 conserved symbols from the alignment display ({\sl Format $\Rightarrow$ Show
1717 nonconserved } in the alignment window or {\sl Selection $\Rightarrow$ Group
1718 $\Rightarrow$ Show Nonconserved} by right clicking on a group). This mode is useful when working with
1719 alignments that exhibit a high degree of homology, because Jalview will only
1720 display gaps or sequence symbols that differ from the consensus for each
1721 column, and render all others with a `.'.
1722 %TODO add a graphic to illustrate this.
1723
1724 \subsection{Annotation Ordering and Display}
1725 % TODO: describe consensus, conservation, quality user preferences, and group
1726 % annotation preferences.
1727 The annotation lines which appear below the sequence alignment are described in
1728 detail in Section \ref{featannot}. They can be hidden by toggling the {\sl Annotations
1729 $\Rightarrow$ Show annotations} menu option. Additionally, each annotation line
1730 can be hidden and revealed in the same way as sequences {\sl via} the
1731 pop-up context menu on the annotation name panel (Figure \ref{annot}).
1732 Annotations can be reordered by dragging the annotation line label on the annotation label panel. Placing the
1733 mouse over the top annotation label brings up a resize icon on the left. When this is
1734 displayed, click-dragging up and down provides either more space in the alignment window for viewing the annotations, or 
1735 less space for the sequence alignment.
1736
1737 \begin{figure}
1738 \begin{center}
1739 \includegraphics[width=2.5in]{images/annot1.pdf}
1740 \includegraphics[width=2.5in]{images/annot2.pdf}
1741 \caption{{\bf Hiding Annotations} Annotations can either be hidden from the {\sl
1742 Annotations} menu (left) or individually from the context menu opened by right clicking their label (right).}
1743 \label{annot}
1744 \end{center}
1745 \end{figure}
1746
1747 %%TODO: multiple views - simple edits - observe changes in other views.
1748
1749
1750 \subsection{Graphical Output}
1751 \label{figuregen}
1752 \parbox[c]{4in}{Jalview allows alignments figures to be exported in different formats, each of which is suited to a particular purpose. 
1753 Image export is {\sl via} the {\sl File $\Rightarrow$ Export Image $\Rightarrow$ \ldots } alignment window menu option. }
1754 \parbox[c]{2in}{\centerline{\includegraphics[width=2in]{images/image.pdf}}}
1755
1756 \subsubsection{HTML}
1757
1758 \parbox[c]{4in}{HTML is the format used by web pages. Jalview outputs the
1759 alignment as a 'Scalable Vector Graphics' (or SVG) file with all the colours and fonts as seen, which is in turn embedded as a 
1760 scrollable component within an HTML page.
1761 %% Functionality lost in 2.9 Any additional annotation will also be embedded as sensitive areas on the page, such as URL links for each sequence's ID label. 
1762 This file can then be viewed directly with any web browser. Unwrapped alignments will produce a very wide page. Export options allow 
1763 original data to be embedded in the HTML file as BioJSON.\footnote{BioJSON was introduced in Jalview 2.9 and fully described 
1764 at \url{https://jalview.github.io/biojson/}}}
1765 \parbox[c]{3.5in}{\centerline{\includegraphics[width=3in]{images/image_html.pdf}}}
1766
1767 \subsubsection{EPS}
1768 \parbox[c]{4in}{EPS is Encapsulated Postscript. {\bf It is the format of choice
1769 for publications and posters} as it gives the highest quality output of any of
1770 the image types. It can be scaled to any size, so will still look good on an A0
1771 poster.
1772 This format can be read by most good presentation and graphics packages such as Adobe Illustrator or Inkscape.
1773 }
1774 \parbox[c]{4in}{\centerline{\includegraphics[width=2in]{images/image_eps.pdf}}
1775 \par \centerline{Zoom Detail of EPS image.}}
1776
1777 \subsubsection{PNG}
1778 \parbox[c]{4in}{
1779 PNG is Portable Network Graphics. This output option produces an image that can be easily included in web pages and incorporated in 
1780 presentations using e.g. Powerpoint or Open Office. It is a bitmap image so does not scale and is unsuitable for use on posters, 
1781 or in publications.
1782
1783 For submission of alignment figures to journals, please use EPS\footnote{If the journal complains, {\em insist}.}.
1784 }
1785 \parbox[c]{4in}{\centerline{\includegraphics[width=2in]{images/image_png.pdf}}
1786 \par \centerline{Zoom Detail of PNG image.}}
1787
1788  \exercise{Graphical Output}{
1789  \label{graphicex}
1790 \exstep{Load the example Jalview Jar file in Exercise \ref{exscreen}. 
1791 Customise it how you wish but leave it unwrapped. 
1792 Select {\sl File $\Rightarrow$ Export Image $\Rightarrow$ HTML} from the alignment menu. 
1793 Save the file and open it in your favoured web browser.  }
1794 \exstep{Wrap the alignment and export the image to HTML again. Compare the two
1795 images. (Note that the exported image matches the format displayed in the
1796 alignment window but {\bf annotations are not exported}).}
1797 \exstep{Export the alignment using the {\sl File $\Rightarrow$ Export Image $\Rightarrow$ PNG} menu option. 
1798 Open the file in an image viewer that allows zooming such as Paint or Photoshop (Windows), or Preview (Mac OS X) and zoom in. 
1799 Notice that the image is a bitmap and it becomes pixelated when zoomed. 
1800 (Note that the {\bf annotation lines are included} in the image.)}
1801 \exstep{Export the alignment using the {\sl File $\Rightarrow$ Export Image
1802 $\Rightarrow$ EPS} menu option. Open the file in a suitable program such as
1803 Photoshop, Illustrator, Inkscape, Ghostview, Powerpoint (Windows), or
1804 Preview (Mac OS X). Zoom in and note that the image has near-infinite
1805 resolution.}
1806 \exstep{Experiment with Jalview's other output options: try exporting an alignment view as 'BioJS', which employs the BioJS Multiple Sequence Alignment viewer. When would you use this type of export option ?}
1807 \exstep{Working with embedded BioJSON data. Drag and drop (or load via the file browser) the 'BioJS' HTML file in the previous step. Compare the original and imported alignment views - are there differences ?}
1808 \bf See the video at:
1809 \url{http://www.jalview.org/training/Training-Videos}.
1810 }
1811
1812 % left out for Glasgow 2016
1813 % \newpage
1814
1815 % \section{Summary - the rest of the manual}
1816
1817 % The first few chapters have covered the basics of Jalview operation: from
1818 % starting the program, importing, exporting, selecting, editing and colouring
1819 % aligments, to the generation of figures for publication, presentation and web
1820 % pages.
1821
1822 % The remaining chapters in the manual cover:
1823
1824 % \begin{list}{$\circ$}{}
1825 % \item{Chapter \ref{featannot} covers the creation, manipulation and visualisation
1826 % of sequence and alignment annotation, and retrieval of sequence and feature data
1827 % from databases.}
1828 % \item {Chapter \ref{msaservices} explores the range of multiple alignment
1829 % programs offered via Jalview's web services, and introduces the use of
1830 % AACon for protein multiple alignment conservation analysis.}
1831 % \item {Chapter \ref{alignanalysis} introduces Jalview's built in tools for
1832 % multiple sequence alignment analysis, including trees, PCA, and alignment
1833 % conservation analysis. }
1834 % \item {Chapter \ref{3Dstructure} demonstrates the structure visualization
1835 % capabilities of Jalview.}
1836 % \item {Chapter \ref{proteinprediction} introduces protein sequence based
1837 % secondary structure and disorder prediction tools, including JPred.}
1838 % \item {Chapter \ref{dnarna} covers the special functions and
1839 % visualization techniques for working with RNA alignments and protein coding
1840 % sequences.}
1841 % \item {Chapter \ref{jvwebservices} provides instructions on the
1842 % installation of your own Jalview web services.}
1843 % \end{list}
1844
1845 \chapter{Annotation and Features}
1846 \label{featannot}
1847 Annotations and features are additional information that is
1848 overlaid on the sequences and the alignment.
1849 Generally speaking, annotations reflect properties of the alignment as a
1850 whole, often associated
1851 with columns in the alignment. Features are often associated with specific
1852 residues in the sequence.
1853
1854 Annotations are shown below the alignment in the annotation panel, the
1855 properties are often based on the alignment.
1856 Conversely, sequence features are properties of the individual sequences, so they do not change with the alignment, 
1857 but are shown mapped on to specific residues within the alignment. 
1858
1859 Features and annotation can be interactively created, or retrieved from external
1860 data sources. Webservices like JPred (see \ref{jpred}) can be used to
1861 analyse a given sequence or alignment and generate annotation for it.
1862
1863
1864 \section{Conservation, Quality, Consensus and other Annotation}
1865 \label{annotationintro}
1866 Jalview automatically calculates several quantitative alignment annotations
1867 which are displayed as histograms below the multiple sequence alignment columns. 
1868 Conservation, quality and consensus scores are examples of dynamic
1869 annotation, so as the alignment changes, they change along with it.
1870 The scores can be used in the hybrid colouring options to shade the alignments. 
1871 Mousing over a conservation histogram reveals a tooltip with more information.
1872
1873 These annotations can be hidden and deleted via the context menu linked to the
1874 annotation row; but they are only created on loading an alignment. If they are
1875 deleted then the alignment should be saved and then reloaded to restore them.
1876 Jalview provides a toggle to autocalculate a consensus sequence upon editing. This is normally selected by default, but can be turned off for
1877 large alignments {\sl via} the {\sl Calculate $\Rightarrow$ Autocalculate
1878 Consensus} menu option if the interface is too slow.
1879
1880 \subsubsection{Conservation Annotation}
1881
1882 Alignment conservation annotation is quantitative numerical index reflecting the
1883 conservation of the physico-chemical properties for each column of the alignment. 
1884 The calculation is based on AMAS method of multiple sequence alignment analysis (Livingstone C.D. and Barton G.J. (1993) CABIOS Vol. 9 No. 6 p745-756), 
1885 with identities scoring highest, and amino acids with substitutions in the same physico-chemical class have next highest score. 
1886 The score for each column is shown below the histogram. 
1887 The conserved columns with a score of 11 are indicated by '*'.
1888 Columns with a score of 10 have mutations but all properties are conserved are marked with a '+'.
1889
1890 \subsubsection{Consensus Annotation}
1891
1892 Alignment consensus annotation reflects the percentage of the different residue
1893 per column. By default this calculation includes gaps in columns, gaps can be ignored via the Consensus label context 
1894 menu to the left of the consensus bar chart. 
1895 The consensus histogram can be overlaid
1896 with a sequence logo that reflects the symbol distribution at each column of
1897 the alignment. Right click on the Consensus annotation row and select the {\sl Show
1898 Logo} option to display the Consensus profile for the group or alignment.
1899 Sequence logos can be enabled by default for all new alignments {\sl via} the
1900 Visual tab in the Jalview desktop's preferences dialog box.
1901
1902 \subsubsection{Quality Annotation}
1903
1904 Alignment quality annotation is an ad-hoc measure of the likelihood of observing
1905 the mutations (if any) in a particular column of the alignment. The quality score is calculated for each column in an alignment by summing, 
1906 for all mutations, the ratio of the two BLOSUM 62 scores for a mutation pair and each residue's conserved BLOSUM62 score (which is higher). 
1907 This value is normalised for each column, and then plotted on a scale from 0 to 1.
1908
1909 \subsubsection{Occupancy Annotation}
1910
1911 Alignment occupancy simply reflects the number of residues aligned at each column
1912 in the multiple sequence alignment. To see this annotation you may first need to enable it by ticking the {\sl Occupancy} check-box
1913 in the {\sl Visual} tab in Jalview's {\sl Preferences} before opening an alignment. Occupancy is particularly useful in conjunction with
1914 the {\sl Select/Hide by Annotations} dialog since it allows the view to be filtered to exclude regions of the alignment with a high proportion of gaps.
1915
1916 \subsubsection{Group Associated Annotation}
1917 \label{groupassocannotation}
1918 Group associated consensus and conservation annotation rows reflect the
1919 sequence variation within a particular group. Their calculation is enabled
1920 by selecting the {\sl Group Conservation} or {\sl Group Consensus} options in
1921 the {\sl Annotation $\Rightarrow$ Autocalculated Annotation } submenu of the
1922 alignment window. 
1923
1924 \subsection{Creating User Defined Annotation}
1925
1926 To create a new annotation row, right click on the annotation label panel and select the {\sl Add New Row} menu option (Figure \ref{newannotrow}).
1927 A dialog box appears. Enter the label to use for this row and a new row will appear.
1928
1929 To create a new annotation, first select all the positions to be annotated on the appropriate row. 
1930 Right-clicking on this selection brings up the context menu which allows the insertion of graphics for secondary structure ({\sl Helix} or {\sl Sheet}), 
1931 text {\sl Label} and the colour in which to present the annotation (Figure \ref{newannot}). On selecting {\sl Label} a dialog box will appear, 
1932 requesting the text to place at that position. After the text is entered, the selection can be removed and the annotation becomes clearly 
1933 visible\footnote{When annotating a block of positions, the text can be partly obscured by the selection highlight. Pressing the  [ESC] key clears 
1934 the selection and the label is then visible.}. Annotations can be coloured or deleted as desired.
1935
1936 \begin{figure}[htbp]
1937 \begin{center}
1938 \includegraphics[width=1.3in]{images/annots1.pdf}
1939 \includegraphics[width=2in]{images/annots2.pdf}
1940 \caption{{\bf Creating a new annotation row.} Annotation rows can be reordered by dragging them to the desired place.}
1941 \label{newannotrow}
1942 \end{center}
1943 \end{figure}
1944
1945 \begin{figure}[htbp]
1946 \begin{center}
1947 \includegraphics[width=2in]{images/annots3.pdf}
1948 \includegraphics[width=2in]{images/annots4.pdf}
1949 \includegraphics[width=2in]{images/annots5.pdf}
1950 \caption{{\bf Creating a new annotation.} Annotations are created from a selection on the annotation row and can be coloured as desired.}
1951 \label{newannot}
1952 \end{center}
1953 \end{figure}
1954
1955 \subsection{Automated Annotation of Alignments and Groups}
1956
1957 On loading a sequence alignment, Jalview will normally\footnote{Automatic
1958 annotation can be turned off in the {\sl Visual } tab in the {\sl Tools
1959 $\Rightarrow$ Preferences } dialog box.} calculate a set of automatic annotation
1960 rows which are shown below the alignment. For nucleotide sequence alignments,
1961 only an alignment consensus row will be shown, but for amino acid sequences,
1962 alignment quality (based on BLOSUM 62) and physicochemical conservation will
1963 also be shown. Conservation is calculated according to Livingstone and
1964 Barton\footnote{{\sl ``Protein Sequence Alignments: A Strategy for the
1965 Hierarchical Analysis of Residue Conservation." } Livingstone C.D. and Barton
1966 G.J. (1993) {\sl CABIOS } {\bf 9}, 745-756}.
1967 Consensus is the modal residue (or {\tt +} where there is an equal top residue).
1968 The inclusion of gaps in the consensus calculation can be toggled by
1969 right-clicking on the Consensus label and selecting {\sl Ignore Gaps in
1970 Consensus} from the pop-up context menu located with consensus annotation row.
1971 Quality is a measure of the inverse likelihood of unfavourable mutations in the alignment. Further details on these
1972 calculations can be found in the on-line documentation.
1973
1974
1975 \exercise{Annotating Alignments}{
1976   \label{annotatingalignex}
1977 \exstep{Load the alignment at \textsf{http://www.jalview.org/tutorial/alignment.fa}. 
1978 Right-click on the label name of the {\sl Conservation} annotation row to
1979 bring up the context menu and select {\sl Add New Row}. A dialog box will
1980 appear asking for {\sl Annotation Name} and {\sl Annotation Description}.
1981 Enter "Iron binding site" and click {\sl OK}. A new, empty, row appears.
1982 }
1983 \exstep{
1984 Navigate to column 97. Move down and on the new annotation row called
1985 "Iron binding site", select column 97.
1986 Right click at this selection and select {\sl Label} from the context menu.
1987 Enter "Fe" in the box and click {\sl OK}. Right-click on the selection again
1988 and select {\sl Colour}.
1989 Choose a colour from the colour chooser dialog 
1990 and click {\sl OK}. Press [ESC] to remove the selection.
1991
1992 {\sl Note: depending on your Annotation sort settings, your newly
1993 created annotation row might "jump" to the top or bottom of the annotation
1994 panel. Just scroll up or down to find it again - the column you marked will
1995 still be selected. }
1996
1997 }
1998 \exstep{ Select columns 70-77 on the annotation row. Right-click and choose {\sl Sheet} from the
1999  context menu. You will be prompted for a label. Enter "B" and press {\sl OK}. A new line showing the 
2000  sheet as an arrow appears. The colour of the label can be changed but not the colour of the sheet 
2001  arrow. 
2002 }
2003 \exstep{Right click on the title text in the annotation row that you just
2004 created.
2005 Select {\sl Export Annotation} in context menu and, in the Export Annotation
2006 dialog box that will open, select the Jalview format and click the {\sl [To Textbox]} button. 
2007 (The format for this file is given in the Jalview help. Press [F1] to open it ([F1]-[Fn] (Mac)),
2008 and find the "Annotations File Format" entry in the "Alignment Annotations" section of the contents 
2009 pane.) }
2010
2011 \exstep{Open a text editor and copy the annotation text into the editor.
2012 Edit the text by changing the name of the annotation row and save the file.}
2013 \exstep{Drag the file onto the alignment in Jalview and check the annotation
2014 panel.} \exstep{Return to the text editor, add an additional helix somewhere
2015 along the row, save the file and re-importing it into Jalview as previously.
2016 {\sl Hint: Use the Export Annotation function to view what helix annotation looks like in 
2017 a Jalview annotation file.}}
2018 \exstep{In the alignment window menu, select {\sl File $\Rightarrow$ Export Annotations...} 
2019 to export all the alignment's annotation to a file. Save the file.}
2020 \exstep{Open the exported annotation in a text editor, and use the Annotation File Format 
2021 documentation to modify the style of the Conservation, Consensus and Quality annotation rows so 
2022 they appear as several lines on a single line graph.
2023 {\sl Hint: You need to change the style of annotation row in the first field of the annotation 
2024 row entry in the file. Create an annotation row grouping to overlay the
2025 three quantitative annotation rows.}
2026 }
2027 \exstep{{\bf Homework once you have completed exercise
2028 \ref{secstrpredex}:}
2029 \label{viewannotfileex}
2030       
2031 Recover or recreate the secondary structure predictions that you made from
2032 JPred. Use the {\sl File $\Rightarrow$ Export Annotation} function to view the Jnet secondary structure prediction annotation row.
2033 Note: the 
2034 SEQUENCE\_REF statements surrounding the row specifying the sequence association for the 
2035 annotation. 
2036 }
2037 \bf See the video at:
2038 \url{http://www.jalview.org/training/Training-Videos}.}
2039
2040
2041 \section{Sequence Features}
2042 Sequence features are annotation associated with a specific sequence - often marking a specific region, such as a domain or binding site. Jalview allows features to be created simply by selecting the area in a sequence (or sequences) to form the feature and selecting {\sl Selection $\Rightarrow$ Create Sequence Feature } from the right-click context menu (Figure \ref{features}). A dialog box allows the user to customise the feature with respect to name, group, and colour. The feature is then associated with the sequence. Moving the mouse over a residue associated with a feature brings up a tool tip listing all features associated with the residue.
2043
2044 \begin{figure}[htbp]
2045 \begin{center}
2046 \includegraphics[width=2in]{images/feature1.pdf}
2047 \includegraphics[width=2.5in]{images/feature2.pdf}
2048 \includegraphics[width=1.5in]{images/feature3.pdf}
2049 \caption{{\bf Creating sequence features.} Features can readily be created from selections via the context menu and are then displayed on the sequence. }
2050 \label{features}
2051 \end{center}
2052 \end{figure}
2053
2054 Creation of features from a selection spanning multiple sequences results in the creation of one feature per sequence. 
2055 Each feature remains associated with its own sequence.
2056
2057 %%TODO: change EMBL to ENA in Jalview and the Manual !
2058
2059 \section{Importing Features from Databases}
2060 \label{featuresfromdb}
2061 Jalview supports feature retrieval from public databases.
2062 It includes built in parsers for Uniprot, Ensembl and ENA (or EMBL) records retrieved
2063 from the EBI. Sequences retrieved from these sources using the sequence fetcher (see
2064 Section \ref{fetchseq}) will already possess features.
2065
2066
2067 \begin{figure}[htbp]
2068 \begin{center}
2069 \includegraphics[width=4in]{images/features4.pdf}
2070 \caption{{\bf Multiple sequence features.} An alignment with JPred secondary structure prediction annotation below it, and many sequence features overlaid onto the aligned sequences. The tooltip lists the features annotating the residue below the mouse-pointer.}
2071 \end{center}
2072 \end{figure}
2073
2074
2075 \subsection{Sequence Database Reference Retrieval}
2076 \label{fetchdbrefs}
2077 Jalview maintains a list of external database references for each sequence in
2078 an alignment. These are listed in a tooltip when the mouse is moved over the
2079 sequence ID when the {\sl View $\Rightarrow$ Sequence ID Tooltip $\Rightarrow$
2080 Show Database Refs } option is enabled. Sequences retrieved using the sequence
2081 fetcher will always have at least one database reference, but alignments
2082 imported from an alignment file generally have no database references.
2083
2084 \subsubsection{Database References and Sequence Coordinate Systems}
2085
2086 Jalview displays features in the local sequence's coordinate system which is
2087 given by its `start' and `end'. Any sequence features on the sequence will be
2088 rendered relative to the sequence's start position. If the start/end positions
2089 do not match the coordinate system from which the features were defined, then
2090 the features will be displayed incorrectly.
2091
2092 \subsubsection{Viewing and Exporting a Sequence's Database Annotation}
2093
2094 You can export all the database cross references and annotation terms shown in
2095 the sequence ID tooltip for a sequence by right-clicking and selecting the {\sl
2096 [Sequence ID] $\Rightarrow$ Sequence Details} option from the popup
2097 menu.
2098 A similar option is provided in the {\sl Selection} sub-menu allowing you to
2099 obtain annotation for the sequences currently selected. 
2100
2101 \parbox[l]{3.4in}{
2102 The {\sl Sequence Details
2103 \ldots} option will open a window containing the same text as would be shown in
2104 the tooltip window, including any web links associated with the sequence. The
2105 text is HTML, and options on the window allow the raw code to be copied and
2106 pasted into a web page.}
2107 \parbox[c]{3in}{
2108 \centerline{\includegraphics[width=2.2in]{images/seqdetailsreport.pdf}}}
2109
2110 \subsubsection{Automatically Discovering a Sequence's Database References}
2111 Jalview includes a function to automatically verify and update each sequence's
2112 start and end numbering against any of the sequence databases that the {\sl
2113 Sequence Fetcher} has access to. This function is accessed from the {\sl
2114 Web Service $\Rightarrow$ Fetch DB References} sub-menu in the Alignment
2115 window. This menu allows you to query either the set of {\sl Standard
2116 Databases}, which includes EMBL, Ensembl, Uniprot, the PDB, or just a specific datasource from one of the submenus.
2117 When one of the entries from this menu is selected, Jalview will use the ID
2118 string from each sequence in the alignment or in the currently selected set to
2119 retrieve records from the external source. Any sequences that are retrieved are
2120 matched against the local sequence, and if the local sequence is found to be a
2121 sub-sequence of the retrieved sequence then the local sequence's start/end
2122 numbering is updated.  A new database reference mapping is created, mapping the
2123 local sequence to the external database, and the local sequence inherits any
2124 additional annotation retrieved from the database sequence.
2125
2126 The database retrieval process terminates when a valid mapping is found for a
2127 sequence, or if all database queries failed to retrieve a matching sequence.
2128 Termination is indicated by the disappearance of the moving progress indicator
2129 on the alignment window. A dialog box may be shown once it completes which
2130 lists sequences for which records were found, but the sequence retrieved from
2131 the database did not exactly contain the sequence given in the alignment (the
2132 {\sl ``Sequence not 100\% match'' dialog box}).
2133
2134
2135 \subsubsection{Rate of Feature Retrieval}
2136 Feature retrieval can take some time if a large number of sources are selected
2137 and if the alignment contains a large number of sequences.  
2138 As features are retrieved, they are immediately added to the current alignment view.
2139 The retrieved features are shown on the sequence and can be customised as described previously.
2140
2141
2142 \subsection{Customising Feature Display}
2143
2144 \begin{figure}[htbp]
2145 \begin{center}
2146 \includegraphics[width=5in]{images/features5.pdf}
2147 \caption{{\bf Customising sequence features.} Features can be recoloured, switched on or off and have the rendering order changed. }
2148 \label{custfeat}
2149 \end{center}
2150 \end{figure}
2151
2152 Feature display can be toggled on or off by selecting the {\sl View
2153 $\Rightarrow$ Show Sequence Features} menu option. When multiple features are
2154 present it is usually necessary to customise the display. Jalview allows the
2155 display, colour, rendering order and transparency of features to be modified
2156 {\sl via} the {\sl View $\Rightarrow$ Feature Settings\ldots} menu option. This
2157 brings up a dialog window (Figure \ref{custfeat}) which allows the
2158 visibility of individual feature types to be selected, assigned colours to be changed (by
2159 clicking on the colour of each sequence feature type) and the rendering order
2160 modified by dragging feature types to a new position in the list. Dragging the
2161 slider alters the transparency of the feature rendering. Clicking in the {\sl Configuration} column
2162  opens the {\sl Display Settings} dialog which allows more complex shading schemes 
2163  and also the creation of filters, and right-clicking opens a context sensitive menu
2164   that offers options for selecting and hiding columns or sorting the alignment according the feature's distribution or score attribute.
2165 These capabilities are described further in sections
2166 \ref{featureschemes} and \ref{featureordering}.
2167
2168
2169 \subsection{Changing how Features are coloured and displayed}
2170 \label{featureschemes}
2171 Sometimes, you may need to visualize the differences in information carried by
2172 sequence features of the same type. This is most often the case when features
2173 of a particular type are the result of a specific type of database query or calculation.
2174 Here, they may also carry information within their textual description, or most commonly
2175 for calculations, a score related to the property being investigated. Features imported
2176 from genomic databases and Variant Call Format files may also have a number of additional
2177 attributes. Jalview allow filters and different types of colouring to be applied to allow variations in these attributes to be highlighted.
2178 In order to create a filter or modify the way a feature type is coloured, select the `Configuration' column for that {\sl Feature Type} in the {\sl Sequence Feature Settings} dialog box. 
2179
2180 Instead of shading a feature with an assigned colour according to its type, you can select the `Colour by text'
2181 option to create feature colours according to the description text associated
2182 with each feature. This is useful for general feature types - such as
2183 Uniprot's `DOMAIN' feature - where the actual type of domain is given in the
2184 feature's description. If other attributes are present you can choose one of them from the drop-down menu.
2185
2186 If Scores or numeric attributes are present, the {\sl Graduated Colour} section of the dialog allows a quantitative
2187 shading scheme to be defined, with the highest
2188 scores receiving the `Max' colour, and the lowest scoring features coloured
2189 with the `Min' colour. Alternately, 
2190 you can define a threshold to exclude low or
2191 high-scoring features from the alignment display. This is done by choosing your
2192 desired threshold type (either above or below), using the drop-down menu in the
2193 dialog box. Then, adjust the slider or enter a value in the text box to set the
2194 threshold for displaying this type of feature.
2195
2196 When filters and complex colourschemes are applied, the configuration column will show coloured blocks or text to indicate the colouring
2197 style and any attribute filters. 
2198
2199
2200 \subsection{Using Features to Re-order the Alignment}
2201 \label{featureordering}
2202 The presence of sequence features on certain sequences or in a particular
2203 region of an alignment can quantitatively identify important trends in
2204 the aligned sequences. In this case, it is more useful to
2205 re-order the alignment based on the number of features or their associated scores, rather than simply re-colour the aligned sequences. 
2206 The sequence feature settings
2207 dialog box provides two buttons: `Sequence sort by Density' and `Sequence sort by
2208 Score', that allow you to reorder the alignment according to the number of
2209 sequence features present on each sequence, and also according to any scores
2210 associated with a feature. Each of these buttons uses the currently displayed
2211 features to determine the ordering, but
2212 if you wish to re-order the alignment using a single type of feature, then you can do this from the {\sl Feature Type}'s
2213 popup menu. Simply right-click the type's style in the Sequence Feature Settings dialog
2214 box, and select one of the {\sl Sort by Score} and {\sl Sort by Density}
2215 options to re-order the alignment. Finally, if a specific region is selected,
2216 then only features found in that region of the alignment will be used to
2217 create the new alignment ordering.
2218 % \exercise{Shading and Sorting Alignments using Sequence Features}{
2219 % \label{shadingorderingfeatsex}
2220
2221 % This exercise is currently not included in the tutorial because no DAS servers
2222 % currently exist that yield per-residue features for any Uniprot sequence. 
2223
2224 % \exstep{Re-load the alignment from \ref{dasfeatretrexcercise}.
2225 % }
2226 % \exstep{Open the
2227 % feature settings panel, and, after first clearing the current
2228 % selection, press the {\em Seq Sort by Density} button a few times.}
2229 % \exstep{Use the DAS fetcher to retrieve the Kyte and Doolittle Hydrophobicity
2230 % scores for the protein sequences in the alignment.
2231 % {\sl Hint: the nickname for the das source is `KD$\_$hydrophobicity'.}}
2232 % \exstep{Change the feature settings so only the hydrophobicity features are
2233 % displayed. Mouse over the annotation and also export and examine the GFF and
2234 % Jalview features file to better understand how the hydrophobicity measurements
2235 % are recorded.}
2236 % \exstep{Apply a {\sl Graduated Colour} to the hydrophobicity annotation to
2237 % reveal the variation in average hydrophobicity across the alignment.}
2238 % \exstep{Select a range of alignment columns, and use one of the sort by feature buttons to order the alignment according to that region's average
2239 % hydrophobicity.}
2240 % \exstep{Save the alignment as a project, for use in exercise
2241 % \ref{threshgradfeaturesex}.} }
2242
2243 % \exercise{Shading alignments with combinations of graduated feature
2244 % colourschemes}{
2245 % \label{threshgradfeaturesex}
2246 % \exstep{Reusing the annotated alignment from exercise
2247 % \ref{shadingorderingfeatsex}, experiment with the colourscheme threshold to
2248 % highlight the most, or least hydrophobic regions. Note how the {\sl Colour} icon for the {\sl Feature Type} changes when you change the threshold type and press OK.}
2249 % \exstep{Change the colourscheme so
2250 % that features at the threshold are always coloured grey, and the most
2251 % hydrophobic residues are coloured red, regardless of the threshold value
2252 % ({\em hint - there is a switch on the dialog to do this for you}).}
2253 % \exstep{Enable the Uniprot {\em chain} annotation in the feature settings
2254 % display and re-order the features so it is visible under the hydrophobicity
2255 % annotation.}
2256 % \exstep{Apply a {\sl Graduated Colour} to the {\em chain}
2257 % annotation so that it distinguishes the different canonical names associated
2258 % with the mature polypeptide chains.}
2259 % \exstep{Export the alignment's sequence features using the Jalview and GFF file formats, to see how the different types of graduated feature
2260 % colour styles are encoded. }
2261 % }
2262
2263
2264 \subsection{Sequence Feature File Formats}
2265
2266 Jalview supports the widely used GFF tab delimited format\footnote{see
2267 http://www.sanger.ac.uk/resources/software/gff/spec.html} and its own Jalview
2268 Features file format for the import of sequence annotation. Features and
2269 alignment annotation are also extracted from other formats such as Stockholm,
2270 and AMSA. URL links may also be attached to features. See the online
2271 documentation for more details of the additional capabilities of the Jalview
2272 features file.
2273
2274 \exercise{Creating Features}{
2275 \label{featuresex}
2276 \exstep{Open the alignment at \textsf{http://www.jalview.org/tutorial/alignment.fa}. 
2277 We know that the Cysteine residues at columns 97, 102, 105 and 135 are involved in 
2278 iron binding so we will create them as features. Navigate to column 97, sequence 1. 
2279 Select the entire column by clicking in the ruler bar. Then right-click on the selection 
2280 to bring up the context menu and select {\sl Selection $\Rightarrow$ Create Sequence Feature}. 
2281 A dialog box will appear.
2282 }
2283 \exstep{
2284 Enter a suitable Sequence Feature Name  (e.g. ``Iron binding site") in the
2285 appropriate box. Click on the Feature Colour bar to change the colour if
2286 desired, add a short description (``One of four Iron binding Cysteines") and
2287 press {\sl OK}. The features will then appear on the sequences. }
2288  \exstep{Roll
2289 the mouse cursor over the new features.
2290 Note that the position given in the tool tip is the residue number, not the column number. 
2291 To demonstrate that there is one feature per sequence, clear all selections by pressing [ESC]. Select the [SHIFT] key,
2292  then insert a gap in sequence 3 at column 95 by moving the mouse.
2293 Roll the mouse cursor over the features and you will see that the feature has moved
2294 with the sequence. Delete the gap you created using {\sl Edit
2295 $\Rightarrow$ Undo}.
2296 }
2297 \exstep{
2298 Add a similar feature to column 102. When the feature dialog box appears, clicking the Sequence Feature 
2299 Name box brings up a list of previously described features. Using the same Sequence Feature Name allows the features to be grouped.}
2300 \exstep{Select {\sl View $\Rightarrow$ Feature Settings\ldots} from the
2301 alignment window menu. The Sequence Feature Settings window will appear. Move
2302 this so that you can see the features you have just created. Click the check
2303 box for ``Iron binding site"  under {\sl Display} and note that display of this
2304 feature type is now turned off. Click it again and note that the features are
2305 now displayed. Close the sequence feature settings box by clicking {\sl OK} or
2306 {\sl Cancel}.} 
2307
2308 \exstep{Select {\sl View $\Rightarrow$ Show Sequence Features} from the
2309 alignment window menu. The sequence features are now hidden. Repeat this step and the features are
2310 displayed.}
2311
2312 \bf See the video at:
2313 \url{http://www.jalview.org/training/Training-Videos}.}
2314
2315 \chapter{Multiple Sequence Alignment}
2316 \label{msaservices}
2317 Sequences can be aligned using a range of algorithms provided by JABA web
2318 services, including ClustalW\footnote{{\sl ``CLUSTAL W:
2319 improving the sensitivity of progressive multiple sequence alignment through sequence
2320 weighting, position specific gap penalties and weight matrix choice."} Thompson
2321 JD, Higgins DG, Gibson TJ (1994) {\sl  Nucleic Acids Research} {\bf 22},
2322 4673-80}, Muscle\footnote{{\sl ``MUSCLE: a multiple sequence alignment method
2323 with reduced time and space complexity"} Edgar, R.C.
2324 (2004) {\sl BMC Bioinformatics} {\bf 5}, 113},  MAFFT\footnote{{\sl ``MAFFT: a
2325 novel method for rapid multiple sequence alignment based on fast Fourier
2326 transform"}  Katoh, K., Misawa, K., Kuma, K. and Miyata, T. (2002) {\sl Nucleic
2327 Acids Research} {\bf 30}, 3059-3066.  and {\sl ``MAFFT version 5:
2328 improvement in accuracy of multiple sequence alignment"} Katoh, K., Kuma, K.,
2329 Toh, H. and Miyata, T. (2005) {\sl Nucleic Acids Research} {\bf 33}, 511-518.},
2330 ProbCons,\footnote{PROBCONS: Probabilistic Consistency-based Multiple Sequence
2331 Alignment.
2332 Do, C.B., Mahabhashyam, M.S.P., Brudno, M., and Batzoglou, S.
2333 (2005) {\sl Genome Research} {\bf 15} 330-340.} T-COFFEE\footnote{T-Coffee:
2334 A novel method for multiple sequence alignments. (2000) Notredame, Higgins and
2335 Heringa {\sl JMB} {\bf 302} 205-217} and Clustal Omega.\footnote{Fast, scalable
2336 generation of high-quality protein multiple sequence alignments using Clustal
2337 Omega. Sievers F, Wilm A, Dineen DG, Gibson TJ, Karplus K, Li W, Lopez R,
2338 McWilliam H, Remmert M, Soding J, Thompson JD, Higgins DG (2011) {\sl Molecular
2339 Systems Biology} {\bf 7} 539
2340 \href{http://dx.doi.org/10.1038/msb.2011.75}{doi:10.1038/msb.2011.75}} Of these,
2341 T-COFFEE is slow but accurate. ClustalW is historically
2342 the most widely used. Muscle is fast and probably best for
2343 smaller alignments. MAFFT is probably the best for large alignments,
2344 however Clustal Omega, released in 2011, is arguably the fastest and most
2345 accurate tool for protein multiple alignment.
2346
2347 \section{Performing a multiple sequence alignment}
2348 To run an alignment web service, select the appropriate method from the {\sl
2349 Web Service $\Rightarrow$  Alignment $\Rightarrow$ \ldots} submenu (Figure
2350 \ref{webservices}). For each service you may either perform an alignment with
2351 default settings, use one of the available presets, or customise the parameters
2352 with the `{\sl Edit and Run ..}' dialog box. Once the job is submitted, a
2353 progress window will appear giving information about the job and any errors that
2354 occur. After successful completion of the job, a new alignment window is opened
2355 with the results, in this case an alignment. By default, the new alignment will be
2356 ordered in the same way as the input sequences. Note: many alignment
2357 programs re-order the input during their analysis and place homologous
2358 sequences close together, the MSA algorithm ordering can be recovered
2359 using the `Algorithm ordering' entry within the {\sl Calculate $\Rightarrow$
2360 Sort } sub menu.
2361
2362 \subsection{Realignment to add sequences to an existing alignment}
2363 The re-alignment option is currently only supported by Clustal  
2364 Omega and ClustalW. When performing a re-alignment, Jalview submits the
2365 current selection to the alignment service complete with any existing gaps.
2366 Realignment with ClustalW is useful when one wishes to align
2367 additional sequences to an existing alignment without any further optimisation
2368 to the existing alignment. ClustalO's realignment works by generating a
2369 probabilistic model (a.k.a HMM) from the original alignment, and then realigns
2370 {\bf all} sequences to this profile. For a well aligned MSA, this process
2371 will simply reconstruct the original alignment (with additional sequences), but
2372 in the case of low quality MSAs, some differences may be introduced.
2373
2374 \begin{figure}[htbp]
2375 \begin{center}
2376 \parbox[c]{1.5in}{\includegraphics[width=1.5in]{images/ws1.pdf}}
2377 \parbox[c]{2.5in}{\includegraphics[width=2.5in]{images/ws2.pdf}}
2378 \parbox[c]{2in}{\includegraphics[width=2in]{images/ws3.pdf}}
2379 \caption{{\bf Multiple alignment via web services} The appropriate method is
2380 selected from the menu (left), a status box appears (centre), and the results
2381 appear in a new window (right).}
2382 \label{webservices}
2383 \end{center}
2384 \end{figure}
2385
2386 \subsection{Alignments of Sequences that include Hidden Regions}
2387 If the view or selected region submitted for alignment contains hidden
2388 regions, then {\bf only the visible sequences will be submitted to the service}.
2389 Furthermore, each contiguous segment of sequences will be aligned independently
2390 (resulting in a number of alignment `subjobs' appearing in the status window).
2391 Finally, the results of each subjob will be concatenated with the hidden regions
2392 in the input data prior to their display in a new window. This approach ensures
2393 that 1) hidden column boundaries in the input data are preserved in the
2394 resulting alignment - in a similar fashion to the constraint that hidden columns
2395 place on alignment editing (see Section \ref{lockededits} and 2) hidden
2396 columns can be used to preserve existing parts of an alignment whilst the
2397 visible parts are locally refined.
2398
2399 \subsection{Alignment Service Limits}
2400 Multiple alignment is a computationally intensive calculation. Some JABA server
2401 services and service presets only allow a certain number of sequences to be
2402 aligned. The precise number will depend on the server that you are using to
2403 perform the alignment. Should you try to submit more sequences than a service
2404 can handle, then an error message will be shown informing you of the maximum
2405 number allowed by the server.
2406
2407 \exercise{Multiple Sequence Alignment}{
2408 \label{msaex}
2409 \exstep{ Close all windows. Open the alignment at {\sf
2410 http://www.jalview.org/tutorial/unaligned.fa}.  Select {\sl
2411 Web Service $\Rightarrow$ Alignment $\Rightarrow$ Muscle with Defaults}. 
2412 A window will open giving the job status. After a short time, a second window will open
2413  with the results of the alignment.} 
2414  \exstep{Return to the first sequence alignment window by clicking on 
2415  the window, and repeat using {\sl ClustalO} (Omega) ({\sl with Defaults}), from the
2416  {\sl Web Service $\Rightarrow$ Alignment} menu, using the same initial
2417  alignment.
2418  Compare them and you should notice small differences. }
2419 \exstep{Select the last three sequences in the MAFFT alignment (you may need the scroll down the alignment), and de-align them 
2420 with {\sl Edit $\Rightarrow$ Remove All Gaps}. Press [ESC] to deselect these
2421 sequences. Then submit this view for re-alignment with {\sl ClustalO}.}
2422 \exstep{Return to the MAFFT alignment window in section (c), use [CTRL]-Z (undo) to
2423 recover the alignment of the last three sequences in this MAFFT alignment.
2424 Once the ClustalO re-alignment has completed, compare the results of
2425 re-alignment of the three sequences with their alignment in the original MAFFT result.}
2426 \exstep{Select columns 60 to 125 in the original MAFFT alignment and hide them,
2427 by right clicking the mouse to bring up context menu.
2428 Select {\sl Web Service $\Rightarrow$ Alignment $\Rightarrow$ Mafft with Defaults} to 
2429 submit the visible portion of the alignment to MAFFT. When the web service job pane appears, 
2430 note that there are now two alignment job status panes shown in the window.}
2431 \exstep{When the MAFFT job has finished, compare the alignment of the N-terminal visible 
2432 region in the result with the corresponding region of the original alignment.}
2433 \exstep {If you wish, 
2434 select and hide a few more columns in the N-terminal region, and submit the alignment to the 
2435 service again and explore the effect of local alignment on the non-homologous parts of the 
2436 N-terminal region.}
2437 {\bf See the video at:
2438 \url{http://www.jalview.org/training/Training-Videos}.}
2439 }
2440
2441 \section{Customising the Parameters used for Alignment}
2442
2443 JABA web services allow you to vary the parameters used when performing a
2444 bioinformatics analysis. For JABA alignment services, this means you are
2445 usually able to modify the following types of parameters:
2446 \begin{list}{$\bullet$}{}
2447 \item{Amino acid or nucleotide substitution score matrix}
2448 \item{Gap opening and widening penalties}
2449 \item{Types of distance metric used to construct guide trees}
2450 \item{Number of rounds of re-alignment or alignment optimisation}  
2451 \end{list}
2452 \begin{figure}[htbc]
2453 \center{
2454 \includegraphics[width=3in]{images/jvaliwsparamsbox.pdf}
2455 \caption{{\bf An alignment service's parameter editing dialog box}.}
2456 \label{jwsparamsdialog} }
2457 \end{figure}
2458
2459 \subsection{Getting Help on the Parameters for a Service}
2460
2461 Each parameter available for a method usually has a short description, which
2462 Jalview will display as a tooltip, or as a text pane that can be opened under
2463 the parameter's controls. In the parameter shown in Figure
2464 \ref{clustalwparamdetail}, the description was opened by selecting the button on the left hand side.
2465
2466 \begin{figure}[htbp]
2467 \begin{center}
2468 \includegraphics[width=2.5in]{images/clustalwparamdetail.pdf}
2469 \caption{{\bf ClustalW parameter slider detail}. From the ClustalW {\sl Clustal $\Rightarrow$ Edit settings and run ...} dialog box. }
2470 \label{clustalwparamdetail}
2471 \end{center}
2472 \end{figure} 
2473
2474 \subsection{Alignment Presets}
2475 The different multiple alignment algorithms available from JABA vary greatly in
2476 the number of adjustable parameters, and it is often difficult to identify what
2477 are the best values for the sequences that you are trying to align. For these
2478 reasons, each JABA service may provide one or more presets -- which are
2479 pre-defined sets of parameters suited for particular types of alignment
2480 problem. For instance, the Muscle service provides the following presets:
2481 \begin{list}{$\bullet$}{}
2482 \item Large alignments (balanced)
2483 \item Protein alignments (fastest speed)
2484 \item Nucleotide alignments (fastest speed)
2485 \end{list}
2486
2487 The presets are displayed in the JABA web services submenu, and can also be
2488 accessed from the parameter editing dialog box, which is opened by selecting
2489 the `{\sl Edit settings and run ...}' option from the web services menu. If you have used
2490 a preset, then it will be mentioned at the beginning of the job status file shown
2491 in the web service job progress window.
2492
2493 \subsection{User Defined Presets}
2494 Jalview allows you to create your own presets for a particular service. To do
2495 this, select the `{\sl Edit settings and run ...}' option for your service,
2496 which will open a parameter editing dialog box like the one shown in Figure
2497 \ref{jwsparamsdialog}.
2498
2499 The top row of this dialog allows you to browse the existing presets, and
2500 when editing a parameter set, allows you to change its nickname. As you
2501 adjust settings, buttons will appear at the top of the parameters dialog that
2502 allow you to Revert or Update the currently selected user preset with your changes, Delete the current preset, or Create a new preset, if none exists with the given name. In addition to the parameter set name, you can also provide a short
2503 description for the parameter set, which will be shown in the tooltip for the
2504 parameter set's entry in the web services menu.
2505
2506 \subsubsection{Saving Parameter Sets}
2507 When creating a custom parameter set, you will be asked for a file name to save
2508 it. The location of the file is recorded in the Jalview user preferences in the
2509 same way as a custom alignment colourscheme, so when Jalview is launched again,
2510 it will show your custom preset amongst the options available for running the
2511 JABA service.
2512
2513 %% TODO - reinstate this exercise about reinstating presets
2514
2515 % \exercise{Creating and using user defined presets}{\label{createandusepreseex}
2516 % \exstep{Import the file at
2517 % \textsf{http://www.jalview.org/tutorial/fdx\_unaligned.fa} into jalview.}
2518 % \exstep{Use the `{\slDiscover Database Ids}' function to recover the PDB cross
2519 % references for the sequences.}
2520 % \exstep{Align the sequences using the default ClustalW parameters.}
2521 % \exstep{Use the `{\sl Edit and run..}'
2522 % option to open the ClustalW parameters dialog box, and create a new preset using
2523 % the following settings:
2524 % \begin{list}{$\bullet$}{}
2525 % \item BLOSUM matrix (unchanged)
2526 % \item Gap Opening and End Gap penalties = 0.05
2527 % \item Gap Extension and Separation penalties = 0.05
2528 % \end{list}
2529
2530 % As you edit the parameters, buttons will appear on the dialog box
2531 % allowing you revert your changes or save your settings as a new parameter
2532 % set.
2533
2534 % Before you save your settings, remeber to give them a meaningful name by editing
2535 % the text box at the top of the dialog box.
2536 % }
2537 % \exstep{Repeat the alignment using your new parameter set by selecting it from
2538 % the {\sl ClustalW Presets menu}.} 
2539 % \exstep{These sequences have PDB structures associated with them, so it is
2540 % possible to compare the quality of the alignments.
2541
2542 % Use the {\sl View all {\bf N}
2543 % structures} option to calculate the superposition of 1fdn on 1fxd for both
2544 % alignments (refer to section \ref{superposestructs} for instructions). Which
2545 % alignment gives the best RMSD ? }
2546 % \exstep{Apply the same alignment parameter settings to the example alignment
2547 % (available from \textsf{http://www.jalview.org/examples/uniref50.fa}). 
2548
2549 % Are there differences ? If not, why not ?
2550 % }
2551 % }
2552
2553 \section{Protein Alignment Conservation Analysis}
2554 \label{aacons}
2555 The {\sl Web Service $\Rightarrow$ Conservation} menu controls the computation
2556 of over 17 different amino acid conservation measures for the current alignment
2557 view. The JABAWS AACon Alignment Conservation Calculation Service, which is used
2558 to calculate these scores, provides a variety of standard measures described by
2559 Valdar in 2002\footnote{Scoring residue conservation. Valdar (2002) {\sl
2560 Proteins: Structure, Function, and Genetics} {\bf 43} 227-241.} as well as an efficient implementation of the SMERFs
2561 score developed by Manning et al. in 2008.\footnote{SMERFS Score Manning et al. {\sl BMC
2562 Bioinformatics} 2008, {\bf 9} 51 \href{http://dx.doi.org/10.1186/1471-2105-9-51}{doi:10.1186/1471-2105-9-51}}
2563
2564 \subsection{Enabling and Disabling AACon Calculations}
2565 When the AACon Calculation entry in the {\sl Web Service $\Rightarrow$
2566 Conservation} menu is ticked, AACon calculations will be performed every time
2567 the alignment is modified. Selecting the menu item will enable or disable
2568 automatic recalculation.
2569
2570 \subsection{Configuring which AACon Calculations are Performed}
2571 The {\sl Web Service $\Rightarrow$ Conservation $\Rightarrow$ Change AACon
2572 Settings ...} menu entry will open a web services parameter dialog for the
2573 currently configured AACon server. Standard presets are provided for quick and
2574 more expensive conservation calculations, and parameters are also provided to
2575 change the way that SMERFS calculations are performed.
2576 AACon settings for an alignment are saved in Jalview projects along with the
2577 latest calculation results.
2578
2579 \subsection{Changing the Server used for AACon Calculations}
2580 If you are working with alignments too large to analyse with the public JABAWS
2581 server, then you will most likely have already configured additional JABAWS
2582 servers. By default, Jalview will chose the first AACon service available from
2583 the list of JABAWS servers available. You can change the AACon services by 
2584 selecting it from the {\sl Web Service $\Rightarrow$
2585 Conservation $\Rightarrow$ Change AACon Settings} submenu.
2586 Alternatively to add new service, go to the desktop window menu and select {\sl Tools $\Rightarrow$
2587 Preferences $\Rightarrow$ Web Services tab} and add {\sl New Services URL}, then use the {\sl move up} or {\sl move down} buttons 
2588 to reorder the services.
2589
2590
2591 \chapter{Analysis of Alignments}
2592 \label{alignanalysis}
2593 Jalview provides support for sequence analysis in two ways. A number of
2594 analytical methods are `built-in', these are accessed from the {\sl Calculate}
2595 alignment window menu. Computationally intensive analyses are run outside
2596 Jalview {\sl via} web services - and found under the
2597 {\sl Web Service} menu. In this section, we describe the built-in analysis
2598 capabilities common to both the Jalview Desktop and the JalviewJS.
2599  
2600 \section{PCA}
2601 Principal components analysis calculations create a spatial
2602 representation of the similarities within the current selection or the whole alignment if no selection has been made. After
2603 the calculation finishes, a 3D viewer displays each sequence as a point in
2604 3D `similarity space'. Sets of similar sequences tend to lie near each other in
2605 this space.
2606 Note: The calculation is computationally expensive, and may fail for very large
2607 sets of sequences - because the JVM has run out of memory. Memory issues, and
2608 how to overcome them, were discussed in Section \ref{memorylimits}.
2609
2610 \subsubsection{What is PCA?}
2611 Principal components analysis is a technique for examining the structure of
2612 complex data sets. The components are a set of dimensions formed from the
2613 measured values in the data set, and the principal component is the one with the
2614 greatest magnitude, or length. The sets of measurements that differ the most
2615 should lie at either end of this principal axis, and the other axes correspond
2616 to less extreme patterns of variation in the data set.
2617 In this case, the components are generated by an eigenvector decomposition of
2618 the matrix formed from the sum of pairwise substitution scores at each aligned
2619 position between each pair of sequences. The basic method is described in the
2620 1995 paper by {\sl G. Casari, C. Sander} and {\sl A. Valencia} \footnote{{\sl
2621 Nature Structural Biology} (1995) {\bf 2}, 171-8.
2622 PMID: 7749921} and implemented at the SeqSpace server at the EBI.\footnote{See \url{http://www.jalview.org/help/html/calculations/pca.html}.}
2623
2624 % Jalview provides two different options for the PCA calculation: SeqSpace and
2625 % Jalview mode. In SeqSpace mode, PCAs are computed using the identity matrix, and
2626 % gaps are treated as 'the unknown residue' (this actually differs from the
2627 % original SeqSpace paper, and will be adjusted in a future version of Jalview).
2628 % In Jalview mode, PCAs are computed using the chosen score matrix - which for
2629 % protein sequences, defaults to BLOSUM 62, and for nucleotides, is the
2630 % DNA identity matrix that also treats Us and Ts as identical, to support analysis
2631 % of both RNA and DNA alignments.
2632
2633 \subsubsection{The PCA Viewer}
2634
2635 PCA analysis can be launched from the {\sl Calculate $\Rightarrow$ Tree or PCA} menu option. 
2636 {\bf PCA requires a selection containing at
2637 least 4 sequences}.  In the Choose Calculation window, select the {\sl Principal Components Analysis} button and then select {\sl Calculate} 
2638 (Figure \ref{PCA}).
2639 Each sequence is represented by a small square, coloured by the background
2640 colour of the sequence ID label. The axes can be rotated by clicking and
2641 dragging the left mouse button and zoomed using the $\uparrow$ and $\downarrow$
2642 keys or the scroll wheel of the mouse (if available).  A tool tip appears if the
2643 cursor is placed over a sequence. Sequences can be selected by clicking on them.
2644 [CTRL]-Click can be used to select multiple sequences.
2645
2646 Labels will be shown for each sequence by toggling the {\sl View $\Rightarrow$
2647 Show labels} menu option, and the plot background colour changed {\sl via} the
2648 {\sl View $\Rightarrow$ Background Colour..} dialog box. A graphical
2649 representation of the PCA plot can be exported as an EPS or PNG image {\sl via}
2650 the {\sl File $\Rightarrow$ Save as $\Rightarrow$ \ldots } submenu.
2651
2652 \exercise{Principal Component Analysis}
2653 {\label{pcaex}
2654 \exstep{Load the alignment at
2655 \textsf{http://www.jalview.org/tutorial/alignment.fa}.}
2656 \exstep{Select the menu option {\sl Calculate $\Rightarrow$ Tree or PCA..}.  in the alignment
2657 window and a dialogue box will open. Select the Principal Component Analysis option
2658 and then click the Calculate button.} 
2659 \exstep{Move
2660 this window within the desktop so that the alignment and PCA viewer windows are visible.
2661 Try rotating the plot by clicking and dragging the mouse on the plot in the PCA window.
2662 Note that clicking on points in the plot will highlight the sequences on the
2663 alignment.}
2664 \exstep{Use the [ESC] key to deselect sequence selection.
2665 Select {\sl Calculate $\Rightarrow$ Tree or PCA..}. in the alignment window. In dialogue box select Neighbour
2666 Joining and in the drop-down list select BLOSUM62. Click the Calculate button
2667 and a tree window will open.}
2668 \exstep{Place the mouse cursor on the tree so that the
2669 tree partition divides the tree into a number of groups, each with a
2670 different (arbitrarily selected) colour.
2671 Note how the colour of the sequence ID label matches both the colour of
2672 the partitioned tree and the points in the PCA plot.} 
2673 {\bf See the video at:
2674 \url{http://www.jalview.org/training/Training-Videos}.}
2675 }
2676
2677 \begin{figure}[hbtp]
2678 \begin{center}
2679 \includegraphics[width=2in]{images/PCA1.pdf}
2680 \includegraphics[width=3in]{images/PCA3.pdf}
2681 \caption{{\bf PCA Analysis.} }
2682 \label{PCA}
2683 \end{center}
2684 \end{figure}
2685
2686
2687
2688 \subsubsection{PCA Data Export}
2689 Although the PCA viewer supports export of the current view, the plots produced
2690 are rarely suitable for direct publication. The PCA viewer's {\sl File} menu
2691 includes a number of options for exporting the PCA matrix and transformed points
2692 as comma separated value (CSV) files. These files can be imported by tools such
2693 as {\bf R} or {\bf gnuplot} in order to graph the data.
2694
2695 \section{Trees}
2696 \label{trees}
2697
2698 Jalview can calculate and display trees, providing interactive tree-based
2699 grouping of sequences though a tree viewer. All trees are calculated {\sl via}
2700 the {\sl Calculate $\Rightarrow$ Tree or PCA \ldots} menu option.
2701 Trees can be calculated from distance matrices determined from \% identity or
2702 aggregate BLOSUM 62 score using either {\sl Average Distance} (UPGMA) or {\sl
2703 Neighbour Joining} algorithms. The input data for a tree is either the selected
2704 region or the whole alignment, excluding any hidden regions.
2705
2706 On calculating a tree, a new window opens (Figure \ref{trees1}) which contains
2707 the tree. Various display settings can be found in the tree window {\sl View}
2708 menu, including font, scaling and label display options. The {\sl File
2709 $\Rightarrow$ Save As} submenu contains options for image and Newick file
2710 export. Newick format is a standard file format for trees which allows them to
2711 be exported to other programs.  Jalview can also read in external trees in
2712 Newick format {\sl via} the {\sl File $\Rightarrow$ Load Associated Tree} menu
2713 option. Leaf names on imported trees will be matched to the associated alignment
2714 - unmatched leaves will still be displayed, and can be highlighted using the
2715 {\sl View $\Rightarrow$ Mark Unlinked Leaves} menu option.
2716
2717
2718
2719 \begin{figure}
2720 \begin{center}
2721 \includegraphics[width=2.5in]{images/trees1.pdf}
2722 \includegraphics[width=2.5in]{images/trees2.pdf}
2723 \includegraphics[width=1.25in]{images/trees4.pdf}
2724 \caption{{\bf Calculating Trees} Jalview provides a range of options 
2725 for calculating trees.
2726 Jalview can also load precalculated trees in Newick format (right).}
2727 \label{trees1}
2728 \end{center}
2729 \end{figure}
2730
2731 \begin{figure}
2732 \begin{center}
2733 \includegraphics[width=5in]{images/trees3.pdf}
2734 \caption{{\bf Interactive Trees} The tree level cutoff can be used to designate
2735 groups in Jalview.}
2736 \label{trees2}
2737 \end{center}
2738 \end{figure}
2739
2740 Clicking on the tree brings up a cursor across the height of the tree. The
2741 sequences are automatically partitioned and coloured (Figure \ref{trees2}). To
2742 group them together, select the {\sl Calculate $\Rightarrow$ Sort $\Rightarrow$
2743 By Tree Order $\Rightarrow$ \ldots} alignment window menu option and choose the
2744 correct tree. The sequences will then be sorted according to the leaf order
2745 currently shown in the tree view. The coloured background to the sequence IDs
2746 can be removed with {\sl Select $\Rightarrow$ Undefine Groups} from the
2747 alignment window menu. Note that tree partitioning will also remove any groups
2748 and colourschemes on a view, so create a new view ([CTRL-T]) if you wish to
2749 preserve these.
2750
2751
2752 \exercise{Trees}
2753 {\label{treeex}
2754
2755 \exstep{Open the alignment at
2756 \textsf{http://www.jalview.org/tutorial/alignment.fa}.}
2757
2758 \exstep{Select {\sl Calculate $\Rightarrow$ Tree or PCA..}. in the alignment
2759 window menu and a dialogue box opens. In the tree section select Neighbour
2760 Joining, in the drop-down list select BLOSUM62 and click the Calculate
2761 button. A tree window will open.}
2762
2763 \exstep{Click on the
2764 tree window, a cursor will appear as a vertical line. Note that clicking will
2765 place this cursor, and divides the tree into a number of groups, each highlighted
2766 with a different colour. Place the cursor to give about 4 groups.}
2767
2768 \exstep{Place the mouse cursor on a node of the tree to open a tool tip. Double click the node to invert the leaves.
2769 }
2770
2771 \exstep{In the tree window, select {\sl View $\Rightarrow$ Sort Alignment
2772 by Tree}. The sequences are reordered to match the order in the tree and groups 
2773  are formed implicitly. Alternatively in the alignment window, select
2774 {\sl Calculate $\Rightarrow$ Sort $\Rightarrow$ By Tree Order $\Rightarrow$
2775  Neighbour Joining Tree using BLOSUM62 from...}.}
2776
2777 \exstep{Select {\sl Calculate $\Rightarrow$ Tree or PCA..}. in the alignment
2778 window. In the dialogue box, select Average Distance and in the drop down
2779 list select BLOSUM62. Click the Calculate button and a new
2780 tree window will appear. The group colouring makes it easy to see the differences between the two
2781 trees calculated by the different methods.}
2782
2783 \exstep{With no groups selected in the alignment window, select sequence 2 from
2784 column 60 to sequence 12 and column 123. Select {\sl Calculate $\Rightarrow$
2785 Tree or PCA..}. , in the dialogue box select Neighbour Joining and
2786 BLOSUM62, then click the Calculate button.
2787  A tree will appear containing 11 sequences. It has been coloured
2788  according to the already selected groups from the first tree and is calculated purely from the residues
2789  in the selection.}
2790
2791 Comparing the location of individual sequences between the three trees illustrates the importance of selecting appropriate regions of the 
2792 alignment for the calculation of trees.
2793
2794 {\bf See the video at:
2795 \url{http://www.jalview.org/training/Training-Videos}.}
2796
2797 }
2798
2799 %\subsubsection{Multiple Views and Input Data recovery from PCA and Tree Viewers}
2800 % move to ch. 3 ?
2801 %Both PCA and Tree viewers are linked analysis windows. This means that their selection and display are linked to a particular alignment, and control and reflect the selection state for a particular view.
2802
2803 \subsubsection{Recovering input data for a Tree or PCA Plot Calculation}
2804 \parbox[c]{5in}{
2805 The {\sl File $\Rightarrow$ Input Data } option will open a new alignment window containing the original data used to calculate the tree or PCA plot (if available). This function is useful when a tree has been created and then the alignment subsequently changed. 
2806 }
2807 \parbox[c]{1.25in}{\centerline{\includegraphics[width=1.25in]{images/pca_fmenu.pdf}
2808 }}
2809
2810 \subsubsection{Changing the associated view for a Tree or PCA Viewer}
2811 \parbox[c]{4in}{
2812 The {\sl View $\Rightarrow$ Associated Nodes With $\Rightarrow$ .. } submenu is shown when the viewer is associated with an alignment that is involved in multiple views. Selecting a different view does not affect the tree or PCA data, but will change the colouring and display of selected sequences in the display according to the colouring and selection state of the newly associated view. 
2813 } \parbox[c]{3in}{\centerline{
2814 \includegraphics[width=2.5in]{images/pca_vmenu.pdf} }}
2815
2816 \subsection{Tree Based Conservation Analysis}
2817 \label{treeconsanaly}
2818
2819 Trees reflect the pattern of global sequence similarity exhibited by the
2820 alignment, or region within the alignment, that was used for their calculation.
2821 The Jalview tree viewer enables sequences to be partitioned into groups based
2822 on the tree. This is done by clicking within the tree viewer window. Once subdivided, the
2823 conservation between and within groups can be visually compared in order to
2824 better understand the pattern of similarity revealed by the tree and the
2825 variation within the clades partitioned by the grouping. The conservation based
2826 colourschemes and the group associated conservation and consensus annotation
2827 (enabled using the alignment window's {\sl Annotations $\Rightarrow$ Autocalculated
2828 Annotation $\Rightarrow$ Group Conservation} and {\sl Group Consensus} options)
2829 can help when working with larger alignments.
2830
2831
2832
2833
2834 %\exercise{Pad Gaps in an Alignment}{
2835 %\exstep{Open the alignment at
2836 % \textsf{http://www.jalview.org/tutorial/alignment.fa}. In alignment window, ensure that the {\sl Edit $\Rightarrow$ Pad Gaps } option is {\sl not} ticked, and insert one gap anywhere in the
2837 %alignment.}
2838 %\exstep{Select {\sl Calculate $\Rightarrow$ Calculate Tree $\Rightarrow$
2839 %Neighbour Joining Using BLOSUM62}.
2840
2841 %A warning dialog box {\bf ``Sequences not aligned'' } appears because the
2842 % sequences input to the tree calculation are of different lengths. }
2843
2844 %\exstep{Select {\sl Edit $\Rightarrow$ tick Pad Gaps } and perform the
2845 %tree calculation again. This time a new tree should appear - because padding
2846 %gaps ensures all the sequences are the same length after editing.}
2847 %{\sl Pad Gaps } option
2848 %can be set in Preferences using
2849 %{\sl Tool $\Rightarrow$ Preference $\Rightarrow$ Editing}.
2850
2851 %{\bf See the video at:
2852 %\url{http://www.jalview.org/training/Training-Videos}.}
2853 %}
2854
2855  \exercise{Tree Based Conservation Analysis}{
2856 \label{consanalyexerc}
2857 \exstep{Load the PF03460 PFAM seed alignment using the sequence fetcher. 
2858 Select {\sl Colour $\Rightarrow$ Taylor $\Rightarrow$ By Conservation}, set
2859  {\sl Conservation} shading threshold at around 20. }
2860  \exstep{Build a Neighbour joining tree by selecting {\sl Calculate
2861  $\Rightarrow$ Tree or PCA..}. in the alignment window. In the dialogue box, select Neighbour
2862 Joining and in the drop-down
2863 list select BLOSUM62, then click the Calculate button.}
2864 \exstep{Use the cursor to select a point on the tree to partition the
2865 alignment into groups.}
2866 \exstep {Select {\sl View $\Rightarrow$ Sort Alignment By Tree} option in the
2867 tree window to re-order the sequences in the alignment.
2868 Examine the variation in colouring between different groups of sequences in the
2869  alignment window. }
2870 \exstep {You may find it easier to browse the alignment if you first uncheck
2871  the {\sl Annotations $\Rightarrow$ Show Annotations} option. Open the
2872 Overview Window from the View menu to aid navigation.}
2873
2874 \exstep{Try changing the colourscheme of the residues in the alignment to
2875 BLOSUM62 (whilst ensuring that {\sl Apply Colour to All Groups} is selected).}
2876 {\sl Note: You may want to save the alignment and tree as a project file, since
2877 it is used in the next set of exercises. }
2878
2879 {\bf See the video at:
2880 \url{http://www.jalview.org/training/Training-Videos}.}
2881 }
2882
2883
2884 \subsection{Redundancy Removal}
2885
2886 The redundancy removal dialog box is opened using the {\sl Edit $\Rightarrow$ Remove Redundancy\ldots} option 
2887 in the alignment menu. As its menu option placement suggests, this is actually an alignment editing function, 
2888 but it is convenient to describe it here. The redundancy removal dialog box presents a percentage identity 
2889 slider which sets the redundancy threshold. Aligned sequences which exhibit a percentage identity greater 
2890 than the current threshold are highlighted in black. The [Remove] button can then be used to delete these 
2891 sequences from the alignment as an edit operation.
2892 \begin{figure}
2893 \begin{center}
2894 \includegraphics[width=5.5in]{images/redundancy.pdf}
2895 \end{center}
2896 \label{removeredundancydialog}
2897 \caption{The Redundancy Removal dialog box opened from the edit menu. Sequences that exceed the current percentage identity 
2898 threshold and are to be removed are highlighted in black.}
2899 \end{figure}
2900
2901
2902 \subsection{Subdividing the Alignment According to Specific Mutations}
2903
2904 It is often necessary to explore variations in an alignment that may correlate
2905 with mutations observed in a particular region; for example, sites exhibiting
2906 single nucleotide polymorphism, or residues involved in substrate recognition in
2907 an enzyme. One way to do this would be to calculate a tree using the specific
2908 region, and subdivide it in order to partition the alignment.
2909 However, calculating a tree can be slow for large alignments, and the tree may
2910 be difficult to partition when complex mutation patterns are being analysed. The
2911 {\sl Select $\Rightarrow$ Make groups for selection } function was introduced to
2912 make this kind of analysis easier. When selected, it will use the characters in
2913 the currently selected region to subdivide the alignment. For example, if a
2914 single column is selected, then the alignment (or each group defined on the
2915 alignment) will be divided into groups based on the residue or nucleotide found
2916 at that position. These new groups are annotated with the characters in the
2917 selected region, and Jalview's group based conservation analysis annotation and
2918 colourschemes can then be used to reveal any associated pattern of sequence
2919 variation across the whole alignment.
2920
2921
2922 % These annotations can be hidden and deleted via the context menu linked to the
2923 % annotation row; but they are only created on loading an alignment. If they are
2924 % deleted then the alignment should be saved and then reloaded to restore them.
2925 % Jalview provides a toggle to autocalculate a consensus sequence upon editing.
2926 % This is normally selected by default, but can be turned off for large alignments {\sl via} the {\sl Calculate $\Rightarrow$ Autocalculate
2927 % Consensus} menu option if the interface is too slow.
2928
2929 % \subsubsection{Group Associated Annotation}
2930 % \label{groupassocannotation}
2931 % Group associated consensus and conservation annotation rows reflect the
2932 % sequence variation within a particular group. Their calculation is enabled
2933 % by selecting the {\sl Group Conservation} or {\sl Group Consensus} options in
2934 % the {\sl Annotation $\Rightarrow$ Autocalculated Annotation } submenu of the
2935 % alignment window. 
2936
2937 % \subsubsection{Alignment and Group Sequence Logos}
2938 % \label{seqlogos}
2939
2940 % The consensus annotation row that is shown below the alignment can be overlaid
2941 % with a sequence logo that reflects the symbol distribution at each column of
2942 % the alignment. Right click on the Consensus annotation row and select the {\sl
2943 % Show Logo} option to display the Consensus profile for the group or alignment.
2944 % Sequence logos can be enabled by default for all new alignments {\sl via} the
2945 % Visual tab in the Jalview desktop's preferences dialog box.
2946
2947 \section{Pairwise Alignments}
2948 Jalview can calculate optimal pairwise alignments between arbitrary 
2949 sequences {\sl via} the {\sl Calculate $\Rightarrow$ Pairwise Alignments\ldots} menu option. 
2950 Global alignments of all pairwise combinations of the selected sequences are performed and the results returned in a text box.
2951
2952
2953
2954 \exercise{Remove Redundant Sequences}{
2955 \label{redundantex}
2956 \exstep{Using the alignment generated in the previous exercise (exercise
2957 \ref{consanalyexerc}).
2958 In the alignment window, you may need to deselect groups using Esc key.}
2959
2960 \exstep{In the {\sl Edit} menu select {\sl Remove Redundancy} to open the
2961 Redundancy threshold selection dialog. Adjust the redundancy threshold value, start
2962 at 50 and increase the value to 65. Sequences selected will change colour in the Sequence ID panel. Select ``Remove'' to
2963 remove the sequences that are more than 65\% similar under this alignment.}
2964
2965 \exstep{From the tree window, select {\sl View $\Rightarrow$
2966 Mark Unlinked Leaves} option, and note that the removed sequences are now prefixed with a * in the tree view.}
2967  \exstep{Use the [Undo] button in the Redundancy threshold selection dialog box
2968 to recover the sequences. Note that the * symbols disappear from the tree display.}
2969 \exstep{Experiment with the redundancy removal and observe the relationship between the percentage identity threshold and 
2970 the pattern of unlinked nodes in the tree display.}
2971 }
2972
2973 \exercise{Group Conservation Analysis}{
2974 \label{conservationex}
2975 \exstep{Re-use or recreate the alignment and tree which you worked with in the
2976 tree based conservation analysis exercise (exercise \ref{consanalyexerc}).} 
2977 \exstep{In the {\sl View} menu in the alignment window, select {\sl New View} to
2978 create a new view. Ensure the annotation panel is displayed ({\sl Annotations $\Rightarrow$ Show Annotations} is toggled on). Enable the
2979 display of {\sl Group Consensus} option by checking {\sl Group Consensus} in the {\sl Annotation $\Rightarrow$
2980 Autocalculated Annotation $\Rightarrow$
2981 Group Consensus} submenu.}
2982
2983 \exstep{Displaying the sequence 
2984 logos will make it easier to see the different residue populations within each
2985 group. Activate the logo by right clicking the name of the Consensus annotation to
2986 open the context menu and select the {\sl Show Logo} option. Alter its size, by moving the cursor onto the annotation row, right clicking the 
2987 mouse and dragging it up. Alter its position, by right clicking the name of the Consensus annotation 
2988 and dragging it up to the top of the annotations.} 
2989 \exstep{In the column alignment ruler, select a column exhibiting with about 50\%
2990   of its residues conserved ({\em ie. about 50\% in the consensus histogram})
2991   that lies within the central conserved region of the alignment.} 
2992 \exstep{Subdivide the alignment
2993 according to this selection using {\sl Select $\Rightarrow$ Make Groups for Selection}.}
2994 \exstep{Re-order the alignment according to the new groups that have been
2995 defined by selecting {\sl Calculate $\Rightarrow$ Sort $\Rightarrow$
2996 By Group}.
2997 Click on the group annotation row IDs to select groups exhibiting a
2998 specific mutation.}
2999 \exstep{Select another column exhibiting about 50\% conservation
3000 overall, and subdivide the alignment further. Note that the new groups
3001 inherit the names of the original groups, allowing you to identify the
3002 combination of mutations that resulted in the subdivision.}
3003 \exstep{Clear the groups, and try to subdivide the alignment using two
3004 non-adjacent columns.
3005
3006 {\sl Hint: You may need to hide the intervening columns before you can select
3007 both of the columns that you wish to use to subdivide the alignment.}}
3008 \exstep{Switch back to the original view, and experiment with subdividing
3009 the tree groups made in the previous exercise.}
3010 {\bf See the video at:
3011 \url{http://www.jalview.org/training/Training-Videos}.}
3012 }
3013
3014 \begin{figure}[]
3015 \begin{center}
3016 \includegraphics[width=4in]{images/pairwise.pdf}
3017 \caption{{\bf Pairwise alignment of sequences.} Pairwise alignments of three selected sequences are shown in a textbox.}
3018 \label{pairwise}
3019 \end{center}
3020 \end{figure}
3021
3022
3023 % To review, Chapter \ref{featannot} describes the mechanisms provided by
3024 % Jalview for interactive creation of sequence and alignment annotation, and how
3025 % they can be displayed, imported and exported and used to reorder the alignment. Chapter
3026 % \ref{featuresfromdb} discusses the retrieval of database references and
3027 % establishment of sequence coordinate systems for the retrieval and display of
3028 % features from databases and DAS annotation services.
3029 % Chapter \ref{msaservices} describes how to use the range of multiple alignment
3030 % programs provided by JABAWS, and Chapter \ref{aacons} introduces JABAWS AACon
3031 % service for protein multiple alignment conservation analysis.
3032 %  In Chapter \ref{alignanalysis}, you will find
3033 % descriptions and exercises on building and displaying trees, PCA analysis,
3034 % alignment redundancy removal, pairwise alignments and alignment conservation
3035 % analysis. 
3036 % Chapter \ref{wkwithstructure} introduces the structure visualization
3037 % capabilities of Jalview.
3038 % Chapter \ref{protsspredservices} explains how to perform protein secondary
3039 % structure predictions with JPred, and JABAWS protein disorder prediction
3040 % services are introduced in Chapter \ref{protdisorderpred}.
3041 % Chapter \ref{workingwithnuc} describes functions and visualization techniques
3042 % relevant to working with nucleotide sequences, coding region annotation and nucleotide
3043 % sequence alignments.
3044 % Chapter \ref{jvwebservices} introduces the various web based services
3045 % available to Jalview users, and Chapter \ref{jabaservices} explains how to
3046 % configure the Jalview Desktop for access to new JABAWS servers.
3047
3048
3049 % and Section \ref{workingwithrna} covers the visualization,
3050 % editing and analysis of RNA secondary structure.
3051
3052 \chapter{Working with 3D structures}
3053 \label{3Dstructure}
3054 \label{wkwithstructure}
3055 Jalview facilitates the use of 3D structure data for the analysis of alignments
3056 by providing a linked view of structures associated with the aligned sequences.
3057 It also allows sequence, secondary structure and B-factor data to be imported
3058 from structure files, and supports the use of the EMBL-EBI's SIFTS database to
3059 construct accurate mappings between UniProt protein sequences and structures
3060 retrieved from the PDB.
3061
3062 \section{Molecular graphics systems supported by Jalview}
3063 Jalview can interactively view 3D structure using Jmol, a Java based molecular
3064 viewing program\footnote{See the Jmol homepage \url{http://www.jmol.org} for
3065 more information.} integrated with Jalview.\footnote{Earlier
3066 versions of Jalview included MCView - a simple main chain structure viewer.
3067 Structures are visualized as an alpha carbon trace and can be viewed, rotated
3068 and coloured using the sequence alignment.} It also supports the use of UCSF
3069 Chimera, a powerful molecular graphics system that needs separate installation.
3070 Jalview can also read PDB and mmCIF format files directly to extract sequences
3071 and secondary structure information, and retrieve records from the European
3072 Protein Databank (PDBe) using the Sequence Fetcher (see \ref{fetchseq}).
3073
3074 \subsection{Configuring the default structure viewer}
3075 \label{configuring3dviewer}
3076 To configure which viewer is used when creating a new
3077 structure view, open the Structures preferences window {\sl via} {\sl Tools $\Rightarrow$ Preferences\ldots} and
3078 select either JMOL or CHIMERA as the default viewer. If you select Chimera,
3079 Jalview will search for the installed program, and if it cannot be found,
3080 you will be prompted to locate the Chimera binary, or alternately, open the UCSF
3081 Chimera download page to obtain the software.
3082
3083 \section{Automatic Association of PDB Structures with Sequences}
3084 Jalview will attempt to automatically determine which structures are associated
3085 with a sequence via its ID, and any associated database references. To do this
3086 for a particular sequence or the current selection, open the Sequence ID popup
3087 menu and select {\sl View 3D Structure}, to open the 3D Structure Chooser. 
3088 %(Figure\ref{auto}). 
3089
3090 When the structure chooser is first opened, if no database identifiers are
3091 available, Jalview will automatically perform a database reference
3092 retrieval (See \ref{fetchdbrefs}) to discover identifiers for the
3093 sequences to use to search the PDB. This can take a
3094 few seconds for each sequence and will be performed for all selected
3095 sequences.\footnote{After this is done, you can see the added database
3096 references in a tool tip by mousing over the sequence ID. You can use the {\sl
3097 View $\Rightarrow$ Sequence ID Tooltip $\Rightarrow$ Show Db References }
3098 submenu option to enable or disable these data in the tooltip.}
3099
3100 Once the retrieval has finished, the structure chooser dialog will show any
3101 available PDB entries for the selected sequences.
3102
3103
3104 % \begin{figure}[htbp]
3105 % \begin{center}
3106 % %TODO fix formatting
3107 % \begin{center} 
3108 % \includegraphics[width=3.5in]{images/pdbstructurechooser.pdf}
3109 % \end{center}
3110
3111
3112 % \caption{{\bf The PDB Structure Chooser dialog.} }
3113 % \label{auto}
3114 % \end{center}
3115 % \end{figure}
3116
3117 \subsection{Drag-and-Drop Association of PDB Files with Sequences by Filename
3118 Match}
3119 \label{multipdbfileassoc}
3120 If you have PDB files stored on your computer {\bf named the same way as the
3121 sequences in the alignment}, then you can drag them from their location on the
3122 file browser onto an alignment window. Jalview will search the alignment for
3123 sequences with IDs that match any of the files, and offer a dialog like the one
3124 in Figure \ref{multipdbfileassocfig}.
3125
3126 If no associations are made, then sequences extracted
3127 from the structure will be simply added to the alignment. However, if only
3128 some of the PDB files are associated, Jalview will raise another dialog box
3129 giving you the option to add any remaining sequences from the PDB structure files not present in
3130 the alignment. This allows you to easily decorate sequences in a newly imported
3131 alignment with any corresponding structures you've already collected in a directory
3132 accessible from your computer.\footnote{We plan to extend this facility in
3133 future so Jalview will automatically search for PDB files matching your
3134 sequence within a local directory. Check out 
3135 \href{http://issues.jalview.org/browse/JAL-801}{Jalview issue 801}}
3136
3137 After associating sequences with PDB files, you can view the PDB structures by
3138 opening the Sequence ID popup
3139 menu and selecting {\sl View 3D Structure}. The PDB files you loaded will be
3140 shown in the {\bf Cached Structures} view, after selecting it from the drop down
3141 menu in the dialog box. 
3142
3143 % there is no mention of the other footnote (#3) that appears saying: Tip: The sequence ID tooltip can often become large for heavily cross-referenced sequence IDs. Use the ...
3144 % JBP: yes there is - under 'Discovery of ' subsection.
3145 \begin{figure}[htbp]
3146 \begin{center}
3147 \includegraphics[]{images/pdbdragdropassoc.pdf}
3148
3149 \caption{{\bf Associating PDB files with sequences by drag-and-drop.} Dragging
3150 PDB files onto an alignment of sequences with names matching the dragged files
3151 names (A), results in a dialog box (B) that gives the option to associate each
3152 file with any sequences with matching IDs. }
3153 \label{multipdbfileassocfig}
3154 \end{center}
3155 \end{figure}
3156
3157
3158 \section{Viewing Structures}
3159 \label{structurechooser}
3160 The structure viewer is launched via the Sequence ID context
3161 menu. To view structures associated with a sequence or a selected set of
3162 sequences in the alignment, simply right click the mouse to open the context
3163 menu, and select {\sl 3D Structure data \ldots} to open the Structure Chooser
3164 dialog box. 
3165
3166 If any of
3167 the {\bf currently selected} sequences have structures in the PDB, 
3168 they will appear in the Structure Chooser dialog box. The structures can be ranked by
3169 different parameters, but are by default ordered according to their PDB
3170 quality score. 
3171
3172 To view one or more structures, simply click {\sl
3173 View} to open a structure viewer containing the structures selected in the
3174 dialog. If several structures were picked, these will be shown
3175 superposed according to the alignment.
3176 You may find Jalview has already picked the best structure - using one of the
3177 criteria shown in the dropdown menu (e.g. 'Best Quality', which is picked by
3178 default). However, you are free to select your own.
3179
3180 The structure(s) to be displayed will be downloaded or loaded from
3181 the local file system, and shown as a ribbon diagram coloured according to the
3182 associated sequence in the current alignment view (Figure \ref{structure}). The structure can be rotated by clicking and dragging in the structure
3183 window. The structure can be zoomed using the mouse scroll wheel or by
3184 [SHIFT]-dragging the structure.
3185
3186 Moving the mouse cursor over a sequence to which the structure is linked in the
3187 alignment view highlights the respective residue's sidechain atoms. The
3188 sidechain highlight may be obscured by other parts of the molecule. Similarly,
3189 moving the cursor over the structure shows a tooltip and highlights the
3190 corresponding residue in the alignment. Clicking the alpha carbon or phosphorous
3191 backbone atom will toggle the highlight and residue label on and off. Often, the
3192 position highlighted in the sequence may not be in the visible portion of the
3193 current alignment view and the sliders will scroll automatically to show the
3194 position. If the alignment window's {\sl View $\Rightarrow$ Automatic Scrolling
3195 } option is not selected, however, then the automatic adjustment will be
3196 disabled for the current view.
3197
3198 \begin{figure}[htbp]
3199 \begin{center}
3200 \parbox{4in}{
3201 {\centering 
3202 \begin{center}
3203 \includegraphics[width=4in]{images/structure1.pdf}
3204 \end{center}
3205 }
3206 }
3207 \parbox{2.2in}{
3208 {\centering 
3209 \begin{center}
3210 \includegraphics[width=2.2in]{images/structure2.pdf}
3211 \end{center}
3212 }
3213 }
3214 \caption{{\bf Structure visualization} Structure viewers are launched from
3215 the 3D Structure chooser dialog (left). Jalview shows the displayed structures
3216 coloured according the alignment view (right). }
3217 \label{structure}
3218 \end{center}
3219 \end{figure}
3220
3221 \subsection{Customising Structure Display}
3222
3223 Structure display can be modified using the {\sl Colour} and {\sl View} menus
3224 in the structure viewer. The background colour can be modified by selecting the
3225 {\sl Colours $\Rightarrow$ Background Colour\ldots} option.
3226
3227 By default, the structure will be coloured in the same way as the associated
3228 sequence(s) in the alignment view from which it was launched. The structure can
3229 be coloured independently of the sequence by selecting an appropriate colour
3230 scheme from the {\sl Colours} menu. It can be coloured according to the
3231 alignment using the {\sl Colours $\Rightarrow$ By Sequence } option. The image
3232 in the structure viewer can be saved as an EPS or PNG with the {\sl File
3233 $\Rightarrow$ Save As $\Rightarrow$ \ldots} submenu, which also allows the raw
3234 data to be saved as PDB format. The mapping between the structure and the
3235 sequence (how well and which parts of the structure relate to the sequence) can
3236 be viewed with the {\sl File $\Rightarrow$ View Mapping} menu option.
3237
3238 \subsubsection{Using the Jmol Visualization Interface }
3239
3240 Jmol has a comprehensive set of selection and visualization functions that are
3241 accessed from the Jmol popup menu (by right-clicking in the Jmol window or by
3242 clicking the Jmol logo). Molecule colour and rendering style can be manipulated,
3243 and distance measurements and molecular surfaces can be added to the view. It
3244 also has its own ``Rasmol\footnote{See \url{http://www.rasmol.org}}-like'' scripting
3245 language, which is described elsewhere\footnote{Jmol Wiki:
3246 \url{http://wiki.jmol.org/index.php/Scripting}
3247
3248 Jmol Scripting reference:
3249 \url{http://www.stolaf.edu/academics/chemapps/jmol/docs/}}. Jalview utilises the
3250 scripting language to interact with Jmol and to store the state of a Jmol
3251 visualization within Jalview archives, in addition to the PDB data file
3252 originally loaded or retrieved by Jalview. To access the Jmol scripting
3253 environment directly, use the {\sl Jmol $\Rightarrow$ Console} menu option.
3254
3255 If you would prefer to use Jmol to manage structure colours, then select the
3256 {\sl Colours $\Rightarrow$ Colour with Jmol} option. This will disable any
3257 automatic application of colour schemes when new structure data is added, or
3258 when associated alignment views are modified.
3259
3260 \exercise{Viewing Structures with the integrated Jmol Viewer}{
3261 \label{viewingstructex}
3262 \exstep{Load the alignment at
3263 \textsf{http://www.jalview.org/examples/exampleFile.jvp}.}
3264 \exstep{Right-click on the
3265 sequence ID label of {\sl FER1\_SPIOL} to open
3266 the ID popup menu and select {\sl 3D Structure Data}. After a short pause, a
3267 Structure Chooser dialog will open for the sequence, listing available
3268 structure data from the PDB. Select { \sl 1a70} from the list and click {\sl
3269 New View}.
3270
3271 {\sl Note:} The Structure Chooser dialog presents available PDB structures
3272 by querying the EMBL-EBI's PDBe web API. Extra information can be
3273 including in this window by checking boxes in the columns of the {\sl Customise Displayed Options} tab.
3274 % JBP Note: Bug JAL-1238 needs to be fixed ASAP
3275 }
3276 \exstep{By default the Jmol
3277 structure viewer opens in the Jalview desktop. Rotate the molecule by clicking
3278 and dragging in the structure viewing box.
3279 Zoom with the mouse scroll wheel. } 
3280 \exstep{In the Jmol viewer, placing the mouse over a
3281 part of the structure will bring up a tool tip indicating the name and number of that residue.
3282 In the alignment window, the corresponding residue in the sequence is
3283 highlighted in black.}
3284 \exstep{Roll the
3285 mouse cursor along the {\sl FER1\_SPIOL} sequence in the alignment window.
3286 If a residue in the sequence maps to one in the structure, the residue molecular shape is visible in the structure viewer.}
3287 \exstep{Clicking the alpha carbon toggles the highlight and residue label on and
3288 off.
3289 Try this by clicking on a set of three or four adjacent residues so that the labels are persistent, then finding where they are in the sequence. }
3290 \exstep{In the structure viewer menu, select {\sl Colours $\Rightarrow$ Background
3291 Colour\ldots} and choose a suitable colour.
3292 Press {\sl OK} to apply this.}
3293 \exstep{Select {\sl File $\Rightarrow$ Save As $\Rightarrow$ PNG} and save the
3294 image. On your computer, view this with a suitable program. } 
3295 \exstep{Select {\sl File $\Rightarrow$ View Mapping} from the structure viewer menu.
3296 A new window opens showing the residue by residue alignment between the sequence and the structure.} 
3297 \exstep{In the structure window,  select {\sl File $\Rightarrow$ Save as $\Rightarrow$ PDB file} and enter a filename to save the PDB file. 
3298 Once the file is saved, open the location in your file browser and drag the PDB file that you just saved onto the Jalview desktop.
3299 (Or load it from the Jalview Desktop menu using
3300 {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ From File}). 
3301 Verify that you can open and view the associated structure from new alignment window using the sequence ID
3302 context menu's {\sl 3D Structure } submenu (as step {\sl b)}.}
3303
3304 \exstep{In the Jmol window, right click on the background to open the
3305 Jmol menu options. Explore this, for example by
3306 {\sl Select (n) $\Rightarrow$ All} command (where {\sl n} is the number of residues selected), 
3307 and then the {\sl Style $\Rightarrow$ Scheme $\Rightarrow$ Ball and Stick} command.} 
3308 \exstep{In the alignment window, use the {\sl File $\Rightarrow$ Save as.. }
3309 function to save the alignment as a Jalview Project (jvp). Now close the alignment and the structure view, and load the project file you just saved.
3310 Verify that the Jmol display is as it was when you just saved the file.}
3311 {\bf See the video at:
3312 \url{http://www.jalview.org/training/Training-Videos}.}
3313 }
3314
3315 \exercise{Aligning Structures using the Ferredoxin Sequence Alignment}{
3316 \label{superpositionex}
3317
3318 \exstep{Continue with the Jalview project created in exercise
3319 \ref{viewingstructex}}
3320
3321 \exstep{Select the FER1\_MAIZE sequence (near bottom of the alignment). Right-click the ID label to open the context menu, 
3322 select {\sl $\Rightarrow$ 3D Structure Data}.}
3323
3324 \exstep{This opens the Structure Chooser dialog, pick 1gaq or 3b2f from the list.
3325 Make sure the {\sl Superpose} option is checked before clicking the {\bf Add}
3326 button. This superimpose the structure associated with
3327 FER1\_MAIZE with the one associated with FER1\_SPIOL.
3328
3329 {\sl Note:} The Jmol view should update to show both structures, and one will be
3330 moved on to the other. If this doesn't happen, use the Align function in the
3331 Jmol submenu.
3332 }
3333
3334 \exstep{Create a new view on the alignment ({\sl View $\Rightarrow$ New View}), and hide all but columns 121
3335 through to 132 ({\sl View $\Rightarrow$ Hide $\Rightarrow$
3336 All but selected region}).}
3337 \exstep{Select the newly created view in the structure window using {\sl Jmol $\Rightarrow$ Superpose
3338 With } submenu, and then recompute the superposition with {\sl Jmol
3339 $\Rightarrow$ Superpose Structures}.
3340
3341 {\sl Note:} how the molecules shift position when superposed with only a small
3342 region of the alignment.}
3343
3344 \exstep{Compare RMSDs obtained when superimposing molecules with
3345 columns 121-132 and with the whole alignment. The RMSD report can be
3346 viewed by right clicking the mouse on Jmol window, and select {\sl
3347 Console} from the menu (if nothing is shown, recompute the superposition after
3348 displaying the console).}
3349 \exstep{Which view do you think give the best 3D superposition, and why ?} }
3350
3351 \exercise{Setting Chimera as the default 3D Structure Viewer}{
3352 \label{viewingchimera} 
3353 Jalview supports molecular structure
3354 visualization using both Jmol and Chimera 3D viewers. Jmol is the default
3355 viewer, however Chimera can be set up as the default choice from Preferences.
3356
3357 \exstep{First, Chimera must be downloaded and installed on the computer.
3358 Chimera program is available on the UCSF web site \textsf{https://www.cgl.ucsf.edu/chimera/download.html}.}
3359 \exstep{In the desktop menu, select {\sl Tool  $\Rightarrow$ Preferences}. In
3360 the ``{\sl
3361 Structure}'' tab set {\sl Default structure viewer} as {\sl
3362 Chimera}; then click {\sl OK}.} 
3363 \exstep{Close the Jalview program, from the
3364 {\sl Desktop menu} select {\sl Jalview $\Rightarrow$ Quit Jalview}. Then reopen
3365 Jalview, Chimera should open as the default viewer.}
3366 If this does not work then you may need to set the {\sl Path to Chimera program} in {\sl Preferences}.
3367 {\sl Note:} The Jmol structure viewer sits within the Jalview desktop. However
3368 the Chimera structure viewer sits outside the Jalview desktop and a Chimera
3369 view window sits inside the Jalview desktop.
3370
3371 {\bf See the video at: \url{http://www.jalview.org/training/Training-Videos}.}}
3372
3373
3374 \subsection{Superimposing Structures}
3375 \label{superposestructs}
3376 Many comparative biomolecular analysis investigations aim to determine if the
3377 biochemical properties of a given molecule are significantly different to its
3378 homologues. When structure data is available, comparing the shapes of molecules
3379 by superimposing them enables substructure that may impart different behaviour
3380 to be quickly identified. The identification of optimal 3D superposition
3381 involves aligning 3D data rather than sequence symbols, but the result can
3382 still be represented as a sequence alignment, where columns indicate positions
3383 in each molecule that should be superposed to recreate the optimal 3D alignment.
3384
3385 Jalview can employ Jmol's 3D fitting routines\footnote{See
3386 \href{http://chemapps.stolaf.edu/jmol/docs/?ver=12.2$\#$compare}{http://chemapps.stolaf.edu/jmol/docs/?ver=12.2$\#$compare}
3387 for more information.} to recreate 3D structure superpositions based on the