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