Correct a few typos.
[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.4in}
84
85 {\large
86
87 David Martin, James Procter, Andrew Waterhouse, Saif Shehata, Nancy Giang,
88
89
90 Suzanne Duce and Geoff Barton
91  
92
93 }
94
95 \vspace{1.2in}
96
97 School of Life Sciences, University of Dundee
98
99 Dundee, Scotland DD1 5EH, UK
100
101
102 \vspace{2in}
103
104 Manual Version 1.8
105 % post CLS lifesci course on 15th January
106 % draft. Remaining items are AACon, RNA visualization/editing and Protein disorder analysis exercises.
107
108 3rd February 2017
109
110
111 \end{center}
112
113 %\newpage
114
115 \clearemptydoublepage
116
117 % ($Revision$) 11th October 2010.}
118 % TODO revise for 2.6
119
120 \pagenumbering{roman}
121 \setcounter{page}{1}
122 \tableofcontents 
123 %\clearemptydoublepage
124 % \listoffigures 
125 % \newpage
126 % \listoftables 
127 \newpage
128 \pagenumbering{arabic}
129 \setcounter{page}{1}
130 \chapter{Basics}
131 \label{jalviewbasics}
132 \section{Introduction}
133 \subsection{Jalview}
134 Jalview is a multiple sequence alignment viewer, editor and analysis tool.
135 Jalview is designed to be platform independent (running on Mac, MS Windows, Linux
136 and any other platforms that support Java). Jalview is capable of editing and
137 analysing large alignments (thousands of sequences) with minimal degradation in
138 performance, and able to show multiple integrated views of the alignment and
139 other data. Jalview can read and write many common sequence formats including
140 FASTA, Clustal, MSF(GCG) and PIR.
141
142
143 There are two types of Jalview program. The {\bf Jalview Desktop} is a standalone 
144 application that provides powerful editing, visualization, annotation and
145 analysis capabilities. The {\bf JalviewLite} applet has the same core
146 visualization, editing and analysis capabilities as the desktop, without the
147 desktop's webservice and figure generation capabilities. It is designed to be
148 embedded in a web page,\footnote{A demonstration version of Jalview (Jalview Micro
149 Edition) also runs on a mobile phone but the functionality is limited to sequence
150 colouring.} and includes a javascript API to allow customisable display of
151 alignments for web sites such as Pfam.\footnote{\url{http://pfam.xfam.org}}
152
153
154 The Jalview Desktop in this version
155 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}} viewer for molecular structures, and the VARNA\footnote{Provided under GPL licence at \url{http://varna.lri.fr}} program for the visualization of 
158 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 Chimera 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. This 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 In addition, the manual covers the additional visualization and
226 analysis techniques available in Jalview. This includes working
227 with the embedded Jmol molecular structure viewer and opening Chimera, building
228 and viewing trees and PCA plots, and using trees for sequence conservation analysis. An overview of
229 the Jalview Desktop's webservices is given in Section \ref{jvwebservices}, and
230 the alignment and secondary structure prediction services are described
231 in detail in Sections \ref{msaservices} and \ref{protsspredservices}
232 respectively.
233 Section \ref{featannot} details the creation and visualization of sequence and alignment annotation. Section \ref{workingwithnuc} discusses
234 specific features of use when working with nucleic acid sequences, such as translation and linking to protein
235 coding regions, and the display and analysis of RNA secondary structure.
236
237 %^Chapter \ref{jalviewadvanced} The third chapter covers the detail^ of Jalview and is aimed at the user who is
238 %already familiar with Jalview operation but wants to get more out of their
239 %Jalview experience.
240
241 \subsubsection{Typographic Conventions}
242
243 Keystrokes using the special non-symbol keys are represented in the tutorial by
244 enclosing the pressed keys with square brackets ({\em e.g.} [RETURN] or [CTRL]).
245
246 Keystroke combinations are combined with a `-' symbol ({\em e.g.} [CTRL]-C means
247 press [CTRL] and the `C' key) simultaneously.
248
249 Menu options are given as a path from the menu
250 that contains them - for example {\sl File $\Rightarrow$ Input Alignment
251 $\Rightarrow$ From URL} means to select the `From URL' option from the `Input
252 Alignment' submenu of a window's `File' dropdown menu.
253
254 \section{Launching the Jalview Desktop Application}
255 \label{startingjv}
256 \begin{figure}[htbp]
257 \begin{center}
258 \includegraphics[width=4.5in]{images/download.pdf}
259 \caption{\bf Download page on the Jalview web site at www.jalview.org.}
260 \label{download}
261 \end{center}
262 \end{figure}
263
264 This tutorial is based on the Jalview
265 Desktop application. Much of the information will also be useful for users of
266 the JalviewLite applet, which has the same core editing, analysis and visualization capabilities (see the
267 \href{http://www.jalview.org/examples/applets.html}{JalviewLite Applet Examples}
268 page for examples). The Jalview Desktop, however, is much more powerful, and
269 includes additional support for interaction with external web services, and
270 production of publication quality graphics.
271
272 The Jalview Desktop can be run in two ways; as an application launched from the
273 web {\sl via} Java webstart, or as an application loaded onto your hard drive. 
274 The webstart version is launched from the pink `Launch Jalview Desktop
275 button' at the top right hand side of pages of the website 
276 \href{http://www.jalview.org}{(www.jalview.org)}.
277 To download the locally installable version, follow the links on the download
278 page
279 \href{http://www.jalview.org/download}{(www.jalview.org/download) }
280  (Figure \ref{download}).
281 These links will launch the latest stable release of Jalview.\par
282
283 %% this paragraph needs to be rewritten for the new signed certificate from Certum.
284
285 When the application is launched with webstart, two dialogs may appear before
286 the application starts. If your browser is not set up to handle webstart, then
287 clicking the launch link may download a file that needs to be opened
288 manually, or prompt you to select the program to handle the webstart
289 file. If that is the case, then you will need to locate the {\bf javaws} program
290 on your system\footnote{The file that is downloaded will have a type of {\bf
291 application/x-java-jnlp-file} or {\bf .jnlp}. The {\bf javaws} program that can run
292 this file is usually found in the {\bf bin} directory of your Java
293 installation}. Once java webstart has been launched, you may also be prompted to
294 accept a security certificate signed by the Barton Group.\footnote{On some
295 systems, the certificate may be signed by 'UNKNOWN'. In this case, clicking
296 through the dialogs to look at the detailed information about the certificate
297 should reveal it to be a Barton group certificate.} You can always trust us, so
298 click trust or accept as appropriate. The splash screen (Figure \ref{splash})
299 gives information about the version and build date that you are running,
300 information about later versions (if available), and the paper to cite in your
301 publications. This information is also available on the Jalview web site at 
302 \url{http://www.jalview.org}.
303
304 %[fig 2] 
305 \begin{figure}[htbp]
306
307 \begin{center}
308 \includegraphics[width=4.5in]{images/splash.pdf}
309 \caption{{\bf Jalview splash screen.}}
310 \label{splash}
311 \end{center}
312 \end{figure}
313
314 When Jalview starts it will automatically load an example alignment from the
315 Jalview site. This behaviour can be switched off in the Jalview Desktop
316 preferences dialog  by unchecking the open file option.
317 This alignment will look like the one in Figure \ref{startpage} (taken
318 from Jalview version 2.10.1).
319
320 %[figure 3 ]
321 \begin{figure}[htbp]
322 \begin{center}
323 \includegraphics[width=4in]{images/start.pdf}
324 \caption{{\bf Default startup for Jalview.}}
325 \label{startpage}
326 \end{center}
327 \end{figure}
328
329
330 \subsubsection{Jalview News RSS Feed}
331
332 Announcements are made available to users of the
333 Jalview Desktop {\sl via} the Jalview Newsreader. This window will open
334 automatically when new news is available, and can also be accessed {\sl via} the
335 Desktop's {\sl Tools $\Rightarrow$ Show Jalview News} menu entry. 
336
337 \begin{figure}[htbp]
338 \begin{center}
339 \includegraphics[height=3in]{images/jvrssnews.pdf}
340 \caption{{\bf The Jalview News Reader.} The newsreader opens automatically
341 when new articles are available from the Jalview Desktop's news channel.}
342 \label{jalviewrssnews}
343 \end{center}
344 \end{figure}
345
346
347 \exercise{Launching Jalview from the Jalview Website}{
348 \label{start}
349 \exstep{Open the Jalview web site
350 \href{http://www.jalview.org}{(www.jalview.org)}
351 in your web browser. Launch Jalview by clicking on the
352 pink `Launch Jalview' Desktop button in the top right hand corner. This
353 will download and open a jalview.jnlp webstart file.}
354 \exstep {Dialog boxes
355 will open and ask if you want to open the jalview.jnlp file as the file is an application downloaded from the
356 Internet, click {\sl Open}. (Note you may be asked to update Java, if you agree
357 then it will automatically update the Java software). As Jalview opens, four demo
358 Jalview windows automatically load.}
359 \exstep {If
360 you are having trouble, it may help changing the browser you are using, as the browsers and
361 its version may affect this process.}
362 \exstep{To deactivate the opening of the 4 demo sequences during the launch, go
363 to the {\sl Tools $\Rightarrow$
364 Preferences...} menu on the desktop. A `Preference'
365 dialog box opens, untick the box adjacent to the `Open file' entry in the
366 `Visual' preferences tab.
367 Click {\sl OK} to save the preferences.}
368 \exstep{Launch another Jalview workbench from the web site by clicking on the
369 pink Launch button.
370 The example alignment should not be loaded as Jalview starts up.}
371 \exstep{To reload the original demo file select the
372 {\em File$\Rightarrow$ From URL} entry in the Desktop menu. Click on
373 the URL history button (a downward arrow on the right hand side of the dialog
374 box) to view the files, select exampleFile\_2\_7.jar, then click {\sl OK}.}
375 {\bf Note:} Should you want to load your own
376 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 window menu and a new window will
395 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 \section{Navigation}
421 \label{jvnavigation}
422 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.  
423
424  Jalview has two navigation and editing modes: {\bf normal mode}, where
425  editing and navigation is performed using the mouse, and {\bf cursor mode}
426  where editing and navigation are performed using the keyboard. The {\bf F2 key}
427  is used to switch between these two modes. With a Mac as the F2 is
428  often assigned to screen brightness, one may often need to  type {\bf function
429  [Fn] key with F2 key} 
430  [Fn]-F2.
431
432 \begin{figure}[htb]
433 \begin{center}
434 \includegraphics[width=6.5in]{images/jalview_anatomy.pdf}
435 \caption{{\bf The anatomy of Jalview.} The major features of the Jalview Desktop Application are labeled.}
436 % TODO: modify text labels to be clearer - black on grey and black border for clarity
437 \label{anatomy}
438 \end{center}
439 \end{figure}
440
441 \subsection{Navigation in Normal Mode}
442
443 Jalview always starts up in Normal mode, where the mouse is used to interact
444 with the displayed alignment view. You can move about the alignment by clicking
445 and dragging the ruler scroll bar to move horizontally, or by clicking and
446 dragging the alignment scroll bar to the right of the alignment to move
447 vertically.  If all the rows or columns in the alignment are displayed, the
448 scroll bars will not be visible.
449
450  Each alignment view shown in the alignment window presents a window onto the
451  visible regions of the alignment. This means that with anything more than a few
452  residues or sequences, alignments can become difficult to visualize on the
453  screen because only a small area can be shown at a time. It can help,
454  especially when examining a large alignment, to have an overview of the whole
455  alignment. Select {\sl View $\Rightarrow$ Overview Window} from the Alignment
456  window menu bar (Figure \ref{overview}\footnote{the menu shown in this figure
457  is from Jalview 2.2, later versions have more options.}).
458 % (Figure4)
459 \begin{figure}[htbp]
460 \begin{center}
461 \includegraphics[width=4.5in]{images/overview.pdf}
462 \caption{{\bf Alignment Overview Window.} The overview window for a view is opened from the {\em View} menu.}
463 \label{overview}
464 \end{center}
465 \end{figure}
466
467 The red box in the overview window shows the current view in the alignment
468 window. A percent identity histogram is plotted below the alignment overview.
469 Shaded parts indicate rows and columns of the alignment that are hidden (in this
470 case, a single row at the bottom of the alignment - see Section
471 \ref{hidingregions}). You can navigate around the alignment by dragging the red
472 box. 
473
474 %Try this now and see how the view in the alignment window changes.
475
476 \parbox[c]{3in}{Alignment and analysis windows are closed by clicking on the
477 usual `close' icon (indicated by arrows on Mac OS X). If you want to close all
478 the alignments and analysis windows at once, then use the {\sl Window
479 $\Rightarrow$ Close All} option from the Jalview desktop.
480
481 {\bf \em{Warning: Make sure you have saved your work because this cannot be
482 undone!}} }
483 \parbox[c]{3in}{\centerline{\includegraphics[width=2.5in]{images/start_closeall.pdf}
484 }}
485
486 \subsection{Navigation in Cursor Mode}
487 \label{cursormode}
488 \parbox[c]{5in}{Cursor mode navigation enables the user to quickly
489 and precisely navigate, select and edit parts of an alignment. On pressing F2 to
490 enter cursor mode the position of the cursor is indicated by a black background
491 and white text. The cursor can be placed using the mouse or moved by pressing
492 the arrow keys ($\uparrow$, $\downarrow$, $\leftarrow$, $\rightarrow$).
493 }\parbox[c]{1.25in}{\centerline{\includegraphics[width=0.8in]{images/cursor1.pdf}}}
494
495 Rapid movement to specific positions is accomplished as listed below:
496 \begin{list}{$\circ$}{}
497 \item {\bf Jump to Sequence {\sl n}:} Type a number {\sl n} then press [S] to
498 move to sequence (row) {\sl n}.
499 \item {\bf Jump to Column {\sl n}:} Type a number {\sl n} then press [C] to move to column {\sl n} in the alignment.  
500 \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.  
501 \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]. 
502 \end{list}
503 \subsection{The Find Dialog Box}
504 \label{searchfunction}
505 A further option for navigation is to use the {\sl Select $\Rightarrow$
506 Find\ldots} function. This opens a dialog box into which can be entered regular
507 expressions for searching sequences and sequence IDs, or sequence numbers.
508 Hitting the [Find next] button will highlight the first (or next) occurrence of
509 that pattern in the sequence ID panel or the alignment, and will adjust the view
510 in order to display the highlighted region. The Jalview Help provides
511 comprehensive documentation for this function, and a quick guide to the regular
512 expressions that can be used with it.
513 %TODO insert a figure for the Find dialog box
514
515 \exercise{Navigation}{
516 Jalview has two navigation and editing modes: {\bf normal} mode (where editing
517 and navigation are via the mouse) and the {\bf cursor} mode (where editing and
518 navigation are via the keyboard).
519 The {\bf F2 key} is used to switch between these two modes. With a Mac, the key
520 combination {\bf Fn key and F2} is needed, as button is
521 often assigned to screen brightness. Jalview always starts up in normal mode.
522
523 \exstep{Load an example alignment from its URL
524 (\url{http://www.jalview.org/examples/exampleFile_2_7.jar}) via the Desktop
525 using {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ From URL} dialog
526 box.
527 (The URL should be stored in its history and clicking on the {\sl down arrow}
528 on the dialog box is an easy way to access it.)}
529 \exstep{Scroll around the alignment using the alignment (vertical) and ruler (horizontal) scroll bars.}
530 \exstep{Find the Overview Window, {\sl Views
531 $\Rightarrow$ Overview Window} and open it. Move around the
532 alignment by clicking and dragging the red box in the overview window.}
533 \exstep{Return to the alignment window, look at the status bar (lower left
534 hand corner of the alignment window) as you move the mouse over the alignment. It indicates information about the
535 sequence and residue under the cursor.}
536 \exstep{Press [F2] key, or [Fn]-[F2] on Mac, to enter Cursor mode. Use
537 the direction keys to move the cursor around the alignment.}
538 \exstep{Move to sequence 7 by pressing {\bf 7 S}. Move to column 18 by pressing
539 {\bf 1 8 C}. Move to residue 18 by pressing {\bf 1 8 P}. Note that these can be
540 two different positions if gaps are inserted into the sequence. Move to sequence 5,
541 column 13 by typing {\bf 1 3 , 5} [RETURN].}
542
543 {\bf Note:} To view Jalview's comprehensive on-line help documentations select
544 {\sl Help} in desktop menu, clicking on {\sl Documentation} will open a
545 Documentation window. Select topic from the navigation panel on the left hand side or use the
546 Search tab to select specific key words.
547
548 {\sl\bf See the video at: 
549 \url{http://www.jalview.org/Help/Getting-Started}.}
550 }
551
552 \section{Loading Sequences and Alignments}
553 \label{loadingseqs}
554 %Jalview provides many ways to load your own sequences. %For this section of the
555 % tutorial you will need to download the file http://www.jalview.org/tutorial/alignment.fa to a suitable location on your hard drive.
556 \subsection{Drag and Drop}
557         In most operating systems you can just drag a file icon from a file browser
558         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.
559         Drag and drop also works when loading data from a URL -
560 simply drag the link or url from the address panel of your browser on to an
561 alignment or the Jalview desktop background and Jalview will load data from the
562 URL directly.
563 %  (Figure \ref{drag})
564 % %[fig 5]
565 % \begin{figure}[htbp]
566 % \begin{center}
567 % \includegraphics[width=2in]{images/drag2.pdf}
568 % \includegraphics[width=2in]{images/drag3.pdf}
569 % \caption{{\bf An alignment can be opened by dragging the file onto the Jalview window. }}
570 % \label{drag}
571 % \end{center}
572 % \end{figure}
573
574 % %\includegraphics[width=2in]{images/drag1.pdf}
575
576
577 \subsection{From a File}
578 Jalview can read sequence alignments from a sequence alignment file. This is a
579 text file, {\bf not} a word processor document. For entering sequences from a
580 wordprocessor document see Cut and Paste  (Section \ref{cutpaste}) below. Select
581 {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ From File} from the main
582 menu (Figure \ref{loadfile}). You will then get a file selection window where
583 you can choose the file to open. Remember to select the appropriate file type.
584 Jalview can automatically identify some sequence file formats.
585
586 %[fig 6]
587 \begin{figure}[htbp]
588 \begin{center}
589 \includegraphics[width=2in]{images/loadfilebox.pdf}
590 %\includegraphics[width=2in]{images/loadfilebox2.pdf}
591 \includegraphics[width=3in]{images/loadfileboxdrop.pdf}
592 \caption{{\bf Opening an alignment from a file saved on disk. }}
593 \label{loadfile}
594 \end{center}
595 \end{figure}
596
597 \subsection{From a URL}
598 Jalview can read sequence alignments directly from a URL. Please note that the
599 files must be in a sequence alignment format - an HTML alignment or graphics
600 file cannot be read by Jalview.
601 Select {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ From URL} from the
602 main menu and a window will appear asking you to enter the URL (Figure
603 \ref{loadurl}). Jalview will attempt to automatically discover the file format.
604
605 %[fig 7]
606 \begin{figure}[htbp]
607 \begin{center}
608 \includegraphics[width=2in]{images/menuloadurl.pdf}
609 \includegraphics[width=3in]{images/loadurlbox.pdf}
610 \caption{{\bf Opening an alignment from a URL. }}
611 \label{loadurl}
612 \end{center}
613 \end{figure}
614
615 \subsection{Cut and Paste}
616 \label{cutpaste}
617 Documents such as those produced by Microsoft Word cannot be readily understood
618 by Jalview. The way to read sequences from these documents is to select the
619 data from the document and copy it to the clipboard. There are two ways to
620 do this. One is to right-click on the desktop background, and select the
621 `Paste to new window' option in the menu that appears. The other is to select
622 {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ From Textbox} from the
623 main menu, paste the sequences into the text window that will appear, and select
624 {\sl New Window} (Figure \ref{loadtext}). In both cases, presuming that they are
625 in the right format, Jalview will happily read them into a new alignment window.
626 %[fig 8]
627
628 \begin{figure}[htbp]
629 \begin{center}
630 \includegraphics[width=2in]{images/menuloadtext.pdf}
631 \includegraphics[width=3in]{images/loadtextbox.pdf}
632 \caption{{\bf Opening an alignment from pasted text. }}
633 \label{loadtext}
634 \end{center}
635 \end{figure}
636
637
638 \subsection{From a Public Database}
639 \label{fetchseq}
640 Jalview can retrieve sequences and sequence alignments from the public databases
641 housed at the European Bioinformatics Institute, including Uniprot, Pfam, Rfam
642 and the PDB. Jalview's sequence fetching capabilities allow you to avoid having to
643 manually locate and save sequences from a web page before loading them into
644 Jalview. It also allows Jalview to gather additional metadata provided by the
645 source, such as annotation and database cross-references.
646 Select {\sl File $\Rightarrow$ Fetch Sequence(s) \ldots} from the main menu and
647 a window will appear (Figure \ref{loadseq}). Pressing the database selection
648 button in the dialog box opens a new window showing all the database sources
649 Jalview can access (grouped by the type of database). Once you've selected the
650 appropriate database, hit OK close the database selection window, and then enter
651 one or several database IDs or accession numbers separated by a semicolon and
652 press OK. Jalview will then attempt to retrieve them from the chosen database.
653 Example queries are provided for some databases to test that a source is
654 operational, and can also be used as a guide for the type of accession numbers
655 understood by the source.
656 % [fig 9]
657 \begin{figure}[htbp]
658 \begin{center}
659 \includegraphics[width=5in]{images/fetchseq.pdf}
660 \caption{{\bf Retrieving sequences from a public database.}}
661 \label{loadseq}
662 \end{center}
663 \end{figure}
664  
665 \subsection{Memory Limits}
666 \label{memorylimits}
667 Jalview is a Java program. One unfortunate implication of this is that Jalview
668 cannot dynamically request additional memory from the operating system. It is
669 important, therefore, that you ensure that you have allocated enough memory to
670 work with your data. On most occasions, Jalview will warn you when you have
671 tried to load an alignment that is too big to fit in to memory (for instance,
672 some of the PFAM alignments are {\bf very} large). You can find out how much
673 memory is available to Jalview with the desktop window's {\sl $\Rightarrow$
674 Tools $\Rightarrow$ Show Memory Usage} function, which enables the display of
675 the currently available memory at the bottom left hand side of the Desktop
676 window's background. Should you need to increase the amount of memory available
677 to Jalview, full instructions are given in the built in documentation (opened by
678 selecting {\sl Help $\Rightarrow$ Documentation}) and on the JVM memory
679 parameters page (\url{http://www.jalview.org/jvmmemoryparams.html}).
680
681 \exercise{Loading Sequences}{
682 \label{load}
683 \exstep{Use {\sl Window $\Rightarrow$ Close All} from the Desktop window menu to
684 close all windows.}
685 \exstep{{\bf Loading sequences from URL:} Selecting File {\sl $\Rightarrow$
686 Input Alignment $\Rightarrow$ From URL} from the Desktop and enter \textsf{http://www.jalview.org/tutorial/alignment.fa} in the box.
687
688 Click {\sl OK} to load the alignment.}
689 \exstep{{\bf Loading sequences from a file:} Close all windows using the
690 {\sl Window $\Rightarrow$ Close All} menu option from the Desktop.
691 Then type the same URL (\url{http://www.jalview.org/tutorial/alignment.fa}) into
692 your web browser and save the file to your desktop.
693 Open the file you have just saved in Jalview by selecting {\sl File
694 $\Rightarrow$ Input Alignment $\Rightarrow$ From File} from the desktop menu and
695 selecting this file.
696 Click {\sl OK} to load.}
697 \exstep{{\bf Loading sequences by `Drag and Drop' / `Cut and Paste':}
698
699 (i) Select {\sl Desktop $\Rightarrow$ Window
700 $\Rightarrow$ Close All}. Then drag the alignment.fa file from the desktop and
701 drop it onto the Jalview window, the alignment should open.
702
703 (ii) Test the differences
704 between (a) dragging the sequence onto the Jalview desktop  and (b)
705 dragging the sequence onto an existing alignment window.
706
707 (iii) Open \url{http://www.jalview.org/tutorial/alignment.fa} in a
708 web browser. Drag the URL directly from browser onto Jalview desktop. (If
709 the URL is downloaded, then locate the file in your
710 download directory and open it in a text editor.)}
711
712 \exstep{{\bf The text editor:} (i) Open the alignment.fa file using text editor.
713 Copy the sequence text from the file into the clipboard and paste it into the desktop
714 background by right-clicking and selecting the {\sl Paste to New Window} menu
715 option.
716
717 (ii) In the text editor, copy the sequence text from
718 alignment.fa  into the clipboard (usually {\sl via} the browser's {\sl Edit
719 $\Rightarrow$ Copy} menu option). 
720
721 (iii) In the Desktop menu, select {\sl File
722 $\Rightarrow$ Input Alignment $\Rightarrow$ From Textbox}.
723 Paste the clipboard into the large window using the {\sl Edit $\Rightarrow$
724 Paste} text box menu option. Click {\sl New Window} and the alignment will be
725 loaded.}
726
727 \exstep{{\bf Loading sequences from Public Database:} (i) Select {\sl File
728 $\Rightarrow$ Fetch Sequence(s)...} from the Desktop. The {\sl Select Database
729 Retrieval Source} dialog will open showing all the database sources. Select the
730 {\bf PFAM seed} database and click {\sl OK}.
731
732 (ii)Once a source has been selected, the {\sl New
733 Sequence Fetcher} window will open. Enter the accession number {\bf PF03460}
734 and click {\sl OK}.
735 An alignment of about 174 sequences should load.}
736 \exstep{These can be viewed using the Overview window accessible from {\sl View
737 $\Rightarrow$ Overview Window.}
738 Several database IDs can be loaded by using semicolons to separate them.}
739 {\bf See the video at:
740 \url{http://www.jalview.org/Help/Getting-Started}} }
741
742 \section{Saving Sequences and Alignments}
743 \label{savingalignments} 
744 \subsection{Saving Alignments} Jalview allows alignments to be saved to file
745 in a variety of formats so they can be restored at a later date, passed to
746 colleagues or analysed in other programs. From the alignment window menu select {\sl File $\Rightarrow$ Save As} and a dialog box
747 will appear (Figure \ref{savealign}). You can navigate to an appropriate
748 directory in which to save the alignment. Jalview will remember the last filename
749 and format used to save (or load) the alignment, enabling you to quickly save
750 the file during or after editing by using the {\sl File $\Rightarrow$ Save}
751 entry. The {\sl File $\Rightarrow$ Output To Textbox} menu option allows the alignment to be copied and pasted into
752 other documents or web servers.
753
754 Jalview offers several different formats in which an alignment can be saved.
755 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
756 produce text files containing just the sequences with no visualization information, although some
757 allow limited annotation and sequence features to be stored (e.g. AMSA).
758 Unfortunately, as far as we are aware only Jalview can read Jalview
759 project files.
760
761 %[fig 10]
762 \begin{figure}[htbp]
763 \begin{center}
764 \parbox[c]{1.0in}{
765 \includegraphics[width=1.0in]{images/saveas.pdf}
766 }
767 \parbox[c]{4in}{
768 \includegraphics[width=4in]{images/saveas2.pdf}
769 }
770 \caption{{\bf Saving alignments in Jalview to disk.}}
771 \label{savealign}
772 \end{center}
773 \end{figure}
774
775 \subsection{Jalview Projects}
776 \parbox[c]{4in}{If you wish to save a complete Jalview session rather than
777 just a single alignment (e.g. because you have calculated trees or multiple
778 different alignments) then save your work as a Jalview Project
779 file (.jvp).\footnote{Tip: Ensure that you have allocated plenty of memory to
780 Jalview when working with large alignments in Jalview projects. See Section 
781 \ref{memorylimits} for how to do this.}
782 From the main menu select {\sl File $\Rightarrow$ Save Project} and a file save
783 dialog box will appear. Loading a project will restore Jalview to exactly the
784 view at which the file was saved, complete with all alignments, trees,
785 annotation and displayed structures rendered appropriately.
786 } \parbox[c]{2in}{ \centerline {
787 \includegraphics[width=1.5in]{images/saveproj.pdf} }}
788
789 \exercise{Saving Alignments}{
790 \label{save}
791 \exstep{Launch Jalview afresh, or use {\sl Desktop $\Rightarrow$ Window
792 $\Rightarrow$ Close all }.}
793 \exstep{Load the ferredoxin
794 alignment ({\bf PF03460}) from {\bf PFAM (seed)} (see Exercise
795 \ref{load}).
796 } \exstep{
797
798 Select {\sl File $\Rightarrow$ Save As} from the alignment window menu. Choose a
799 location into which to save the alignment and select your preferred format. All
800 formats except {\sl  Jalview } jvp can be viewed in a normal text editor (e.g.
801 Notepad) or in a web browser.
802 Enter a file name and click {\sl Save}.}
803 \exstep{Check this file by closing all windows and opening it with Jalview, or by
804 browsing to it with your web browser.}
805 \exstep{Repeat the previous steps saving the files in different file formats.}
806 \exstep{Select {\sl File $\Rightarrow$ Output to Textbox $\Rightarrow$ FASTA}.
807 Select and copy this alignment to the clipboard using the textbox menu options
808 {\sl Edit $\Rightarrow$ Select All} followed by {\sl Edit $\Rightarrow$ Copy}.
809 The alignment can then be pasted into any application of choice, e.g. a word processor or web form.
810 }
811 \exstep{Ensure at least one alignment window is active in Jalview. Open the
812 overview window {\sl View $\Rightarrow$ Overview Window}
813  and scroll red box to any part of the alignment.
814 Select {\sl File
815 $\Rightarrow$ Save Project} from the main menu and save the project in a
816 suitable folder.}
817
818 \exstep{Close all windows and then load the project {\sl via} the {\sl File
819 $\Rightarrow$ Load Project} menu option. Observe how all the windows and
820 positions are exactly as they were when they were saved. } 
821 {\bf See the video at: \url{http://www.jalview.org/Help/Getting-Started}.}
822 }
823
824
825 \chapter{Selecting and Editing Sequences }
826 \label{jalviewediting}
827
828 \label{selectingandediting} 
829 Jalview makes extensive use of selections - most of the commands available from
830 its menus operate on the {\sl currently selected region} of the alignment, either to
831 change their appearance or perform some kind of analysis. This section
832 illustrates how to make and use selections and groups.
833
834 \section{Selecting Parts of an Alignment}
835 Selections can be of arbitrary regions in an alignment, one or more complete columns, or one or 
836 more complete sequences.
837 A selected region can be copied and pasted as a new alignment 
838 using the {\sl Edit $\Rightarrow$ Copy} and {\sl Edit $\Rightarrow$ Paste $\Rightarrow$ To New 
839 Alignment}  in the alignment window menu options.
840 {\bf To clear (unselect)  the selection press the [ESC] (escape) key.}
841
842 \subsection{Selecting Arbitrary Regions}
843 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. 
844 A dashed red box appears around the selected region (Figure \ref{select}). 
845 %[fig 12]
846
847 \begin{figure}[htbp]
848 \begin{center}
849 \includegraphics[width=4in]{images/select1.pdf}
850 \caption{{\bf Selecting a region in an alignment.}}
851 \label{select}
852 \end{center}
853 \end{figure}
854
855 \subsection{Selecting Columns}
856 To select the same residues in all sequences, click and drag along the alignment ruler.
857 This selects the entire column of the alignment. Ranges of positions from the
858 alignment ruler can also be selected by clicking on the first position and then
859 holding down the [SHIFT] key whilst clicking the other end of the selection.
860 Discontinuous regions can be selected by holding down [CTRL] and clicking on
861 positions to add to the column selection. Note that each [CTRL]-Click (PC) or
862 [CMD]-Click (Mac) changes the current selected sequence region to that column,
863 but adds to the column selection.
864 Selected columns are indicated by red highlighting in the ruler bar (Figure \ref{selectcols}).
865 %[fig 13]
866
867 \begin{figure}[htbp]
868 \begin{center}
869 \includegraphics[width=4in]{images/select2.pdf}
870 \caption{{\bf Selecting multiple columns in an alignment.} The red highlighting
871 on the alignment ruler marks the selected columns. Note that only the most
872 recently selected column has a dashed-box around it to indicate a region
873 selection. }
874 \label{selectcols}
875 \end{center}
876 \end{figure}
877
878 \subsection{Selecting Sequences}
879
880 \begin{figure}[htb]
881 \begin{center}
882 \includegraphics[width=4in]{images/select3.pdf}
883 \caption{{\bf Selecting multiple sequences in an alignment.} Use [CTRL] or [SHIFT] to select many sequences at once.}
884 \label{selectrows}
885 \end{center}
886 \end{figure}
887
888 To select multiple complete sequences, click and drag the mouse down the
889 sequence ID panel. The same techniques as used for columns (above) can be used
890 with [SHIFT]-Click for continuous and [CTRL]-Click to select discontinuous
891 ranges of sequences (Figure \ref{selectrows}).
892 %[fig 14]
893
894 \subsection{Making Selections in Cursor Mode}
895
896 To define a selection in cursor mode (which is enabled by pressing [F2] when the alignment window is selected),
897 navigate to the top left corner of the proposed selection (using the mouse, the arrow keys, or the keystroke
898 commands described in Section \ref{cursormode}). Pressing the [Q] key marks this as the
899 corner. A red outline appears around the cursor (Figure \ref{cselect}).
900
901 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.
902
903 \begin{figure}[htbp]
904 \begin{center}
905 \includegraphics[width=1.5in]{images/csel1.pdf}
906 \includegraphics[width=1.5in]{images/csel2.pdf}
907 \includegraphics[width=1.5in]{images/csel3.pdf}
908 \includegraphics[width=1.5in]{images/csel4.pdf}
909 \caption{{\bf Making a selection in cursor mode.} Navigate to the top left
910 corner (left), press [Q], navigate to the bottom right corner and press [M] (right).}
911 \label{cselect}
912 \end{center}
913 \end{figure}
914
915 \begin{figure}
916 \begin{center}
917 \includegraphics[width=3in]{images/group1.pdf}
918 \includegraphics[width=1.5in]{images/newgroup.pdf}
919 \caption{{\bf Creating a new group from a selection.}}
920 \label{makegroup}
921 \end{center}
922 \end{figure}
923
924 \subsection{Inverting the Current Selection}
925 The current sequence or column selection can be inverted, using  {\sl Select
926 $\Rightarrow$ Invert Sequence/Column Selection} in the alignment window.
927 Inverting the selection is useful when selecting large regions in an alignment, 
928 simply select the region that is to be kept unselected, and then invert the selection.
929 This may also be useful when hiding large regions in an alignment (see Section \ref{hidingregions} 
930 below).
931 Instead of selecting the columns and rows that are to be hidden, simply select the 
932 region that is to be kept
933 visible, invert the selection, then select {\sl View $\Rightarrow$ Hide
934 $\Rightarrow$ Selected Region}.
935
936 \section{Creating Groups}
937 Selections are lost as soon as a different region is selected. Groups can be
938 created which are labeled regions of the alignment. To create a group, first
939 select the region which is to comprise the group. Then click the right mouse
940 button on the selection to bring up a context menu. Select {\sl Selection
941 $\Rightarrow$ Group $\Rightarrow$ Edit name and description of
942 current group}\footnote{In earlier versions of Jalview, this entry was variously
943 `Group', `Edit Group Name', or `JGroupXXXXX' (Where XXXXX was some serial
944 number).} then enter a name for the group in the dialog box which appears.
945
946 By default the new group will have a box drawn around it. The appearance of the group can be changed (see Section \ref{colours} below). This group will stay defined even when the selection is removed.
947
948 \exercise{Making Selections and Groups}{
949 \label{exselect}
950 \exstep{Close windows.
951
952 Load the ferredoxin alignment ({\bf PF03460} from {\bf PFAM (seed)}).
953 }
954 \exstep{Selecting an arbitrary region. Choose a residue and place the mouse
955 cursor on it (residue information will show in alignment window status
956 bar).
957 Click and drag the mouse to the bottom-right to create a selection. As you drag,
958 a red box will `rubber band' out to 
959 show the extent of the selection.
960 Release the mouse
961 button and a red box borders the selected region.
962 Press [ESC] to clear this.}
963 \exstep{ Select one sequence by clicking on
964 the sequence ID panel. Note that the sequence ID takes on a highlighted
965 background and a red box appears around the selected sequence. 
966 Hold down [SHIFT] and click another sequence ID a few positions above or below. 
967 Note how the selection expands to include all the sequences between the two positions on which you clicked.
968 Hold down [CTRL] and then click on several sequences' IDs - both selected and
969 unselected. Note how unselected IDs are individually added to the selection and previously selected IDs are 
970 individually deselected.}
971 \exstep{ Select columns by clicking on the Alignment Ruler. Note
972 that the selected column is marked with a red box.
973 Hold down [SHIFT] and click a column beyond. Note the selection expands to
974 include all the sequences between the two positions on which you clicked.}
975
976 \exstep{Enter Cursor mode using [F2], or [Fn]-F2 for Macs.
977 Navigate to column 59, row 1 by pressing {\bf 5 9 , 1 [RETURN]}.
978 Press {\bf Q} to mark this position.
979 Navigate to column 65, row 8 by pressing {\bf 6 5 , 8 [RETURN]}. Press {\bf M}
980 to complete the selection. Note to clear the selection press the [ESC]
981 key.}
982 \exstep{To create a group from the selected the region, click the
983 right mouse button when mouse is on the selection, this opens a
984 context menu in the alignment window.
985
986 Open the {\sl Selection $\Rightarrow$ Edit New Group $\Rightarrow$ Group Colour
987 } menu and select {\sl Percentage Identity}.
988 This will turn the selected region into a group and colour it accordingly.}
989 \exstep{Hold down [CTRL] and use the mouse to select and deselect sequences in
990 the alignment by clicking on their Sequence ID label. Note how the group expands
991 to include newly selected sequences, and the Percentage Identity colouring changes. }
992 \exstep{ Another way to resize the group is by using the mouse to click and drag
993 the right-hand edge of the selected group.}
994
995 \exstep{The current selection can be exported and saved by right clicking the
996 mouse when on the text area to open the Sequence ID context menu. Follow the
997 menus and pick an output format (eg BLC) from the {\sl Selection $\Rightarrow$ Output to Textbox
998 \ldots} submenu.
999 }
1000 \exstep{In the Alignment output window that opens, try manually editing the
1001 alignment before clicking the {\sl New Window} button. This opens the
1002 edited alignment in a new alignment window.} {\bf See the video at:
1003 \url{http://www.jalview.org/training/Training-Videos}.}
1004 % more? change colouring style. set border colour.
1005 }
1006
1007 \section{Exporting the Current Selection}
1008 The current selection can be copied to the clipboard (in PFAM format). It can
1009 also be output to a textbox using the output functions in the pop-up menu
1010 obtained by right clicking the current selection. The textbox enables quick
1011 manual editing of the alignment prior to importing it into a new window (using
1012 the {\sl New Window} button) or saving to a file with the {\sl File
1013 $\Rightarrow$ Save As } pulldown menu option from the text box.
1014
1015 \section{Reordering an Alignment}
1016 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.
1017
1018 \begin{figure}[htbp]
1019 \begin{center}
1020 \includegraphics[width=3in]{images/move1.pdf}
1021 \includegraphics[width=3in]{images/move2.pdf}
1022 \caption{{\bf Reordering the alignment.} The selected sequence moves up one
1023 position on pressing the $\uparrow$ key.}
1024 \label{reorder}
1025 \end{center}
1026 \end{figure}
1027
1028 \exercise{Reordering the Alignment}{
1029 \exstep{Close windows.
1030
1031 Load the ferredoxin alignment ({\bf PF03460} from {\bf PFAM (seed)}).
1032 }
1033 \exstep{Select one of the sequence in the sequence ID panel, use the up and down
1034 arrow keys to alter the sequence's position in the alignment. (Note that
1035 this will not work in cursor mode)}
1036 \exstep{To select and move multiple
1037 sequences, use hold [SHIFT], and select two sequences separated by
1038 one or more un-selected sequences, repeat using the [CTRL] key. Note how
1039 multiple sequences are grouped together when they are re-ordered using the up and down arrow keys.}
1040 {\bf See the video at: \url{http://www.jalview.org/training/Training-Videos}.}
1041 }
1042
1043
1044 \section{Hiding Regions}
1045 \label{hidingregions}
1046 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}).
1047
1048 To hide a set of sequences, select them and right-click the mouse on the
1049 selected sequence IDs to bring up the context pop-up menu. Select {\sl Hide
1050 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.
1051
1052
1053  \begin{figure}[htbp]
1054 \begin{center}
1055 \includegraphics[width=1.5in]{images/hide1.pdf}
1056 \includegraphics[width=2.5in]{images/hide2.pdf}
1057 \includegraphics[width=1.75in]{images/hide3.pdf}
1058 \caption{{\bf Hiding Sequences} Hidden sequences are represented by a small blue
1059 triangle in the sequence ID panel.}
1060 \label{hideseq}
1061 \end{center}
1062 \end{figure}
1063
1064 A similar mechanism applies to columns (Figure \ref{hidecol}). Selected columns
1065 (indicated by a red marker) can be hidden and revealed in the same way {\sl via}
1066 the context pop-up menu by right clicking on the ruler bar. The hidden column
1067 selection is indicated by a small blue triangle in the ruler bar.
1068
1069  \begin{figure}[htbp]
1070 \begin{center}
1071 \includegraphics[width=2in]{images/hide4.pdf}
1072 \includegraphics[width=3in]{images/hide5.pdf}
1073 \includegraphics[width=1in]{images/hide6.pdf}
1074 \caption{{\bf Hiding Columns} Hidden columns are represented by a small blue
1075 triangle in the ruler bar.}
1076 \label{hidecol}
1077 \end{center}
1078 \end{figure}
1079
1080 It is often easier to select the region that you intend to work with, rather
1081 than the regions that you want to hide. In this case, select the required region and use the {\sl View $\Rightarrow$ Hide
1082 $\Rightarrow$ All but Selected Region } menu entry, or press [Shift]+[Ctrl]+H
1083 to hide the unselected region.
1084
1085 \subsection{Representing a Group with a Single Sequence}
1086
1087 Instead of hiding a group completely, it is sometimes useful to work with just one representative sequence. The {\sl $<$Sequence ID$>$ $\Rightarrow$ Represent group with $<$Sequence ID$>$ } option from the sequence ID pop-up menu enables this variant of the hidden groups function. The remaining representative sequence can be visualized and manipulated like any other. However, any alignment edits that affect the sequence will also affect the whole sequence group. 
1088
1089 \exercise{Hiding and Revealing Regions}{
1090 \exstep{Close windows.
1091
1092 Load the ferredoxin alignment ({\bf PF03460} from {\bf PFAM (seed)}).
1093 }
1094 \exstep{Select a contiguous set of sequences by clicking and dragging on the sequence ID panel.
1095 Right click on the selected sequence IDs to bring up the sequence ID context
1096 menu, select {\sl Hide Sequences}.
1097 }
1098 \exstep{
1099 Right click on the blue triangle indicating hidden sequences and select {\sl
1100 Reveal Sequences} in the panel. (If you have hidden all sequences then you will
1101 need to use the alignment window menu option {\sl View $\Rightarrow$ Show $\Rightarrow$ 
1102 All Sequences.}) }
1103 \exstep{
1104 Repeat the process but use a non-contiguous set of sequences. Note that when
1105 multiple regions are hidden you can select either {\sl
1106 Reveal Sequences} to reveal the hidden sequences that were clicked, or {\sl
1107 Reveal All}.
1108 }
1109 \exstep{Repeat the above using columns to hide and reveal columns
1110 instead of sequences.}
1111 \exstep{Select a region of the alignment, and experiment with the {\sl Hide all
1112 but selected region} option in {\sl View $\Rightarrow$ Hide $\Rightarrow$ All
1113 but selected region.}} \exstep{Select some sequences, pick one to represent the rest by hovering
1114 the mouse over this sequence. Bring up the Sequence ID context menu by right
1115 clicking and select {\sl (Sequence ID name) $\Rightarrow$ Represent group
1116 with (Sequence ID name )}. To reveal these hidden sequences, right click on the
1117 Sequence ID and in the context menu select {\sl Reveal All}.}
1118 {\bf See the video at:  \url{http://www.jalview.org/training/Training-Videos}.}
1119 }
1120
1121
1122 \begin{figure}[htb]
1123 \begin{center}
1124 \includegraphics[width=3in]{images/edit1.pdf}
1125 \includegraphics[width=3in]{images/edit2.pdf}
1126 \caption{{\bf Introducing gaps in a single sequence.} Gaps are introduced as the
1127 selected sequence is dragged to the right while pressing and holding [SHIFT].}
1128 \label{gapseq}
1129 \end{center}
1130 \end{figure}
1131
1132 \begin{figure}[htb]
1133 \begin{center}
1134 \includegraphics[width=3in]{images/edit3.pdf}
1135 \includegraphics[width=3in]{images/edit4.pdf}
1136 \caption{{\bf Introducing gaps in a group.} Gaps are introduced as the selected
1137 group is dragged to the right with [CTRL] pressed.}
1138 \label{gapgroup}
1139 \end{center}
1140 \end{figure}
1141
1142 \section{Introducing and Removing Gaps}
1143 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).
1144
1145
1146 \subsection{Undoing Edits}
1147 Alignment edits can be undone {\sl via} the {\sl Edit $\Rightarrow$ Undo Edit}
1148 alignment window menu option, or CTRL-Z. An edit, if undone, may be re-applied
1149 with {\sl Edit $\Rightarrow$ Redo Edit}, or CTRL-Y. Note, however, that the
1150 {\sl Undo} function only works for edits to the alignment or sequence ordering.
1151 Colouring of the alignment, showing and hiding of sequences or modification of
1152 annotation that only affect the alignment's display cannot
1153 be undone.
1154
1155 \subsection{Locked Editing}
1156 \label{lockededits}
1157 The Jalview alignment editing model is different to that used in other alignment
1158 editors. Because edits are restricted to the insertion and deletion of gaps to the left of a particular sequence position, 
1159 editing has the effect of shifting the rest of the sequence(s) being edited down or up-stream with respect to the rest of 
1160 alignment. The {\sl Edit $\Rightarrow$ Pad Gaps} option can be enabled to eliminate `ragged edges' at the end of the alignment, 
1161 but does not avoid the `knock-on' effect which is sometimes undesirable. 
1162 However, its effect can be limited by performing the edit within a selected region. 
1163 In this case, gaps will only be removed or inserted within the selected region. 
1164 Edits are similarly constrained when they occur adjacent to a hidden column.
1165
1166 \subsection{Introducing Gaps in a Single Sequence}
1167 To introduce a gap, first select the sequence in the sequence ID panel and
1168 then place the cursor on the residue to the immediate right of where the gap
1169 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.
1170
1171 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.
1172
1173 \subsection{Introducing Gaps in all Sequences of a Group}
1174 To insert gaps in all sequences in a selection or group, select the
1175 required sequences in the sequence ID panel and then place the mouse cursor on
1176 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.
1177
1178 Gaps can be removed by dragging the residue to the immediate right of the gap
1179 leftwards whilst holding down [SHIFT] (for single sequences) or [CTRL] (for a group of sequences).
1180
1181 \subsection{Sliding Sequences}
1182 Pressing the [$\leftarrow$] or [$\rightarrow$] arrow keys when one or more
1183 sequences are selected will ``slide'' the entire selected sequences to the left
1184 or right (respectively). Slides occur regardless of the region selection -
1185 which, for example, allows you to easily reposition misaligned subfamilies
1186 within a larger alignment.
1187 % % better idea to introduce hiding sequences, and use the invert selection, hide
1188 % others, to simplify manual alignment construction
1189
1190 \subsection{Editing in Cursor mode}
1191 Gaps can be easily inserted when in cursor mode (toggled with [F2]) by
1192 pressing [SPACE]. Gaps will be inserted at the cursor, shifting the residue
1193 under the cursor to the right. To insert {\sl n} gaps type {\sl n} and then
1194 press [SPACE]. To insert gaps into all sequences of a group, use [CTRL]-[SPACE]
1195 or [SHIFT]-[SPACE] (both keys held down together).
1196
1197 Gaps can be removed in cursor mode by pressing [BACKSPACE]. First make sure you
1198 have everything unselected by pressing ESC. The gap under the cursor will be
1199 removed. To remove {\sl n} gaps, type {\sl n} and then press [BACKSPACE]. Gaps
1200 will be deleted up to the number specified. To delete gaps from all sequences of
1201 a group, press [CTRL]-[BACKSPACE] or [SHIFT]-[BACKSPACE] (both keys held down
1202 together). Note that the deletion will only occur if the gaps are in the same
1203 columns in all sequences in the selected group, and those columns are to the
1204 right of the selected residue.
1205
1206 \newpage
1207
1208 \exercise{Editing Alignments}
1209   %\label{mousealedit}
1210 % TODO: VERIFY FOR 2.6.1 and 2.7 - NUMBERING/INSTRUCTIONS APPEAR OFF
1211 {You are going to manually reconstruct part of the example Jalview
1212 alignment available at
1213  \href{http://www.jalview.org/examples/exampleFile.jar}
1214  {http://www.jalview.org/examples/exampleFile.jar}.
1215
1216 {\sl {\bf Mac Users:} Please use the Apple or [CMD] key in place of [CTRL]
1217 for key combinations such as [CTRL]-A. }
1218
1219 Remember to use [CTRL]-Z to undo an edit, or the {\sl File $\Rightarrow$
1220  Reload } function to revert the alignment back to the original version if you
1221  want to start again.
1222
1223 \exstep{ Load the URL
1224 \textsf{http://www.jalview.org/tutorial/unaligned.fa} which contains part of the
1225 ferredoxin alignment from PF03460.}
1226
1227 \exstep{ Select the first 7 sequences, and press H to hide them (or right click
1228 on the sequence IDs to open the sequence ID context menu, and select {\sl Hide
1229 Sequences}).}
1230
1231 \exstep{ Select FER3\_RAPSA and FER\_BRANA. Slide the sequences to
1232 the right so the initial residue A lies at column 57 using the $\Rightarrow$
1233 key.}
1234
1235 \exstep{ Select FER1\_SPIOL, FER1\_ARATH, FER2\_ARATH, Q93Z60\_ARATH and
1236 O80429\_MAIZE
1237
1238 {\sl Hint: you can do this by pressing [CTRL]-I to invert the sequence selection and then
1239 deselect FER1\_MAIZE), and use the $\Rightarrow$ key to slide them to so they
1240 begin at column 5 of the alignment view.}} 
1241
1242 \exstep{ Select all the visible
1243 sequences (those not hidden) in the block by pressing [CTRL]-A.
1244 Insert a single
1245 gap in all selected sequences at column 38 of the alignment by holding [CTRL]
1246 and clicking on the R at column 38 in the FER1\_SPIOL, then drag one
1247 column to right.
1248 Insert another gap at column 47 in all sequences in the same way.}
1249
1250 \exstep{ Correct the ferredoxin domain alignment for FER1\_SPIOL by
1251 inserting two additional gaps after the gap at column 47. First press [ESC] to
1252 clear the selection, then hold [SHIFT] and click and drag on the G and move it
1253 two columns to the right.}
1254
1255 \exstep{ Now complete the
1256 alignment of FER1\_SPIOL with a locked edit by pressing [ESC] and select
1257 columns 47 to 57 of the FER1\_SPIOL row. Move the mouse onto the G at column 50,
1258 hold [SHIFT] and drag the G in column 47 of FER1\_SPIOL to the left by one
1259 column to insert a gap at column 57.}
1260
1261 \exstep{ In the next two steps you will complete the alignment of the last two 
1262 sequences.
1263
1264 Select the last two sequences (FER1\_MAIZE and O80429\_MAIZE), then press [SHIFT]
1265 and click and drag the initial methionine of O80429\_MAIZE 5 columns to the right
1266 so it lies at column 10.
1267
1268 Keep holding [SHIFT] and click and drag to insert
1269 another gap at the proline at column 25 (25C in cursor mode). Remove the gap at
1270 column 44, and insert 4 gaps at column 47 (after AAPM).}
1271
1272 \exstep{ Hold [SHIFT] and drag the I at column 39 of FER1\_MAIZE 2 columns to the
1273 right. Remove the gap at FER1\_MAIZE column 49 by [SHIFT]-click and drag left by
1274 one column. Press [ESC] to clear the selection, and then insert three gaps in
1275 FER1\_MAIZE at column 47 by holding [SHIFT] and click and drag the S in FER1\_MAIZE to the right by three columns. Finally,
1276 remove the gap in O80429\_MAIZE at column 56 using [SHIFT]-drag to the left on
1277 56C.}
1278
1279 \exstep{ Use the
1280 {\sl Edit $\Rightarrow$ Undo Edit} and {\sl Edit $\Rightarrow$ Redo Edit} menu
1281 option, or their keyboard shortcuts ([CTRL]-Z and [CTRL]-Y) to step 
1282 backwards and replay the edits you have made.}
1283 }
1284
1285
1286 \exercise{Keyboard Edits}
1287 {This continues on from the previous exercise, and recreates the final part of the example ferredoxin
1288 alignment from the unaligned sequences using Jalview's keyboard editing mode.
1289
1290 {\bf Window users:} Please {\em only use} [SHIFT]-[SPACE] in this
1291 exercise.
1292
1293 {\bf Mac users:} [CTRL]-[SPACE] can also be used instead of [SHIFT]-[SPACE].
1294
1295 \exstep{Load the sequence alignment at
1296 \textsf{http://www.jalview.org/tutorial/unaligned.fa}, or continue using the
1297 edited alignment.  If you continue from the
1298 previous exercise, first right click on the sequence ID panel and select
1299 {\sl Reveal All}. Enter cursor mode by pressing [F2].}
1300 % TODO: BACKSPACE or DELETE WHEN SEQS ARE SELECTED WILL DELETE ALL SEQS JAL-783
1301
1302 \exstep{Insert 58 gaps at the start of the sequence 1 (FER\_CAPAA). Press
1303 {\sl 58} then {\sl [SPACE]}. }
1304
1305 \exstep{Go down one sequence and select rows 2-5 as a block. Click on the second sequence ID (FER\_CAPAN).
1306  Hold down shift and click on the fifth (FER1\_PEA). }
1307
1308 \exstep{Insert 6 gaps at the start of this group. Go to column 1 row 2 by typing
1309 {\sl 1,2} then press {\sl [RETURN]}. Now insert 6 gaps in all the sequences.
1310 Type {\sl 6} then hold down {\sl [SHIFT]} and press {\sl [SPACE]}.}
1311 \exstep{Now insert one gap at column 34 and another at 38. Insert 3 gaps at 47.
1312 Press {\sl 34C} then {\sl [SHIFT]-[SPACE]}.  Press {\sl 38C} then
1313 [SHIFT]-[SPACE].
1314 Press {\sl 47C} then {\sl 3 [SHIFT-SPACE]} the first through fourth sequences
1315 are now aligned.}
1316 \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]} .}
1317 \exstep{ Similarly delete the gap now at column 34, then insert two gaps at
1318 column 38.
1319 Press {\sl 34C [BACKSPACE]  38C 2 [SPACE]}. Delete three gaps at column 44 and
1320 insert one at column 47 by pressing {\sl 44C 3 [BACKSPACE] 47C [SPACE]}.  The top five sequences are 
1321 now aligned.}}
1322
1323 \chapter{Colouring Sequences and Figure Generation}
1324 \label{colouringfigures}
1325 \section{Colouring Sequences}
1326 \label{colours}
1327
1328 Colouring sequences is a key aspect of alignment presentation. Jalview allows
1329 you to colour the whole alignment, or just specific groups. Alignment and
1330 group colours are rendered
1331 {\sl below} any other colours, such as those arising from sequence features
1332 (these are described in Section \ref{featannot}). This means that if you
1333 try to apply one of the colourschemes described in this section, and nothing
1334 appears to happen, it may be that you have sequence feature annotation
1335 displayed, and you may have to disable it using the {\sl View $\Rightarrow$
1336 Show Features} option before you can see your colourscheme.
1337
1338 There are two main types of colouring styles: {\bf simple static residue}
1339 colourschemes and {\bf dynamic schemes} which use conservation and consensus
1340 analysis to control colouring. {\bf Hybrid colouring} is also possible, where
1341 static residue schemes are modified using a dynamic scheme. The individual schemes are described in Section \ref{colscheme} below.
1342
1343 \subsection{Colouring the Whole Alignment}
1344
1345 \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. 
1346
1347 }\parbox[c]{3in}{
1348 \centerline {
1349 \includegraphics[width=2.5in]{images/colour2.pdf}
1350 }
1351 }
1352
1353 \subsection{Colouring a Group or Selection}
1354
1355 Selections or groups can be coloured in two ways. The first is {\sl via} the Alignment Window's {\sl Colour} menu as stated above,
1356  after first ensuring that the {\sl Apply Colour To All Groups} flag is {\bf
1357  not} selected.
1358  This must be turned {\sl off} specifically as it is {\sl on} by default. 
1359  When unticked, selections from the Colours menu will only change the colour for residues in the current selection, 
1360  or the alignment view's ``background colourscheme'' when no selection exists.
1361
1362 The second method is to select sequences and right click mouse to open pop-up
1363 menu and select {\sl Selection $\Rightarrow$ Edit New Group $\Rightarrow$ Group
1364 Colour} from context menu options
1365 (Figure \ref{colgrp}). This only changes the colour of the current selection or group.
1366
1367 \begin{figure}[htbp]
1368 \begin{center}
1369 %TODO update group_col.pdf to show latest jalview group edit submenu
1370 \includegraphics[width=4in]{images/group_col.pdf}
1371 \caption{{\bf Colouring a group via the context menu.}}
1372 \label{colgrp}
1373 \end{center}
1374 \end{figure}
1375
1376 \subsection{Shading by Conservation}
1377 For many colour schemes, the intensity of the colour in a column can be scaled
1378 by the degree of amino acid property conservation. Selecting {\sl Colour
1379 $\Rightarrow$ By Conservation} enables this mode, and {\sl Modify
1380 Conservation Threshold...} brings up a selection box (the {\sl Conservation
1381 Colour Increment} dialog box) allowing the alignment colouring to be modified.
1382 Selecting a higher value limits colouring to more highly conserved columns (Figure \ref{colcons}).
1383
1384  \begin{figure}[htbp]
1385 \begin{center}
1386 \includegraphics[width=2in]{images/colourcons1.pdf}
1387 \includegraphics[width=2in]{images/colourcons3.pdf}
1388 \includegraphics[width=2in]{images/colourcons5.pdf}
1389 \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.
1390 }
1391 \label{colcons}
1392 \end{center}
1393 \end{figure}
1394
1395 \subsection{Thresholding by Percentage Identity}
1396
1397 `Thresholding' is another hybrid colour model where a residue is only coloured
1398 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).
1399
1400 \subsection{Colouring by Annotation}
1401 \label{colourbyannotation}
1402 \parbox[c]{3.2in}{
1403 Any of the {\bf quantitative} annotations shown on an alignment can be used to
1404 threshold or shade the whole alignment.\footnote{Please remember to turn off
1405 Sequence Feature display to see the shading} 
1406
1407 The {\sl Colour $\Rightarrow$ By
1408 Annotation} option opens a dialog which allows you to select which annotation
1409 to use, the minimum and maximum shading colours or whether the original
1410 colouring should be thresholded (the `Use original colours' option).
1411
1412 Default settings for minimum and maximum colours can be set in the Jalview
1413 Desktop's preferences.  
1414 }\parbox[c]{3in}{
1415 \centerline{\includegraphics[width=2.8in]{images/col_byannot.pdf}}}
1416
1417 The {\bf per Sequence} option in the {\bf Colour By Annotation} dialog
1418 allows each sequence to be shaded according to sequence associated annotation
1419 rows, such as protein disorder scores. This functionality is described further
1420 in Section \ref{protdisorderpred}.
1421
1422 \subsection{Colour Schemes} 
1423
1424 \label{colscheme}
1425 Full details on each colour scheme can be found in the Jalview on-line help. A brief description of each one is provided below:
1426
1427 \subsubsection{ClustalX}
1428
1429
1430  \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. }
1431 \parbox[c]{3in}{\includegraphics[width=2.75in]{images/col_clustalx.pdf}}
1432
1433 \subsubsection{Blosum62}
1434
1435 \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.}
1436 \parbox[c]{3in}{
1437 \includegraphics[width=2.75in]{images/col_blosum62.pdf}
1438 }
1439
1440 \subsubsection{Percentage Identity}
1441 \parbox[c]{3.5in}{
1442 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.
1443 }
1444 \parbox[c]{3in}{
1445 \includegraphics[width=2.75in]{images/col_percent.pdf}
1446 }
1447
1448 \subsubsection{Zappo}
1449 \parbox[c]{3.5in}{
1450 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.
1451 }
1452 \parbox[c]{3in}{
1453 \includegraphics[width=2.75in]{images/col_zappo.pdf}
1454 }
1455
1456 \subsubsection{Taylor}
1457
1458 \parbox[c]{3.5in}{
1459 This colour scheme was devised by Willie Taylor and an entertaining description of its origin can be found in Protein Engineering, 
1460 Vol 10 , 743-746 (1997).
1461 }
1462 \parbox[c]{3in}{
1463 \includegraphics[width=2.75in]{images/col_taylor.pdf}
1464 }
1465
1466 \subsubsection{Hydrophobicity}
1467 \parbox[c]{3.5in}{
1468 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.
1469 }
1470 \parbox[c]{3in}{
1471 \includegraphics[width=2.75in]{images/col_hydro.pdf}
1472 }
1473
1474 \subsubsection{Helix Propensity}
1475
1476 \parbox[c]{3.5in}{
1477 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.
1478 }
1479 \parbox[c]{3in}{
1480 \includegraphics[width=2.75in]{images/col_helix.pdf}
1481 }
1482
1483 \subsubsection{Strand Propensity}
1484
1485 \parbox[c]{3.5in}{
1486 The residues are coloured according to their Chou-Fasman\textsuperscript{\ref{chou-fasman}} Strand propensity. The highest propensity is Yellow, the lowest is blue.
1487 }
1488 \parbox[c]{3in}{
1489 \includegraphics[width=2.75in]{images/col_strand.pdf}
1490 }
1491
1492
1493
1494 \subsubsection{Turn Propensity}
1495 \parbox[c]{3.5in}{
1496 The residues are coloured according to their Chou-Fasman\textsuperscript{\ref{chou-fasman}} turn propensity. The highest propensity is red, the lowest is cyan.
1497 }
1498 \parbox[c]{3in}{
1499 \includegraphics[width=2.75in]{images/col_turn.pdf}
1500 }
1501
1502 \subsubsection{Buried Index}
1503 \parbox[c]{3.5in}{
1504 The residues are coloured according to their Chou-Fasman\textsuperscript{\ref{chou-fasman}} burial propensity. The highest propensity is blue, the lowest is green.
1505 }
1506 \parbox[c]{3in}{
1507 \includegraphics[width=2.75in]{images/col_buried.pdf}
1508 }
1509  
1510
1511 \subsubsection{Nucleotide}
1512 \parbox[c]{3.5in}{ Residues are coloured with four colours corresponding to the
1513 four nucleotide bases. All non ACTG residues are uncoloured. See Section
1514 \ref{workingwithnuc} for further information about working with nucleic acid
1515 sequences and alignments.
1516 } \parbox[c]{3in}{ \includegraphics[width=2.75in]{images/col_nuc.pdf} }
1517
1518 \subsubsection{Purine Pyrimidine}
1519 \parbox[c]{3.5in}{ Residues are coloured according to whether the corresponding
1520 nucleotide bases are purine (magenta) or pyrimidine (cyan) based. All non ACTG
1521 residues are uncoloured. For further information about working with nucleic acid
1522 sequences and alignments, see Section \ref{workingwithnuc}.
1523 %and Section \ref{workingwithrna}
1524
1525 } \parbox[c]{3in}{ \includegraphics[width=2.75in]{images/col_purpyr.pdf} }
1526
1527 \subsubsection{RNA Helix Colouring}
1528 \parbox[c]{3.5in}{ Columns are coloured according to their assigned RNA helix as
1529 defined by a secondary structure annotation line on the alignment. Colours for
1530 each helix are randomly assigned, and option only available when an RNA
1531 secondary structure row is present on the alignment. 
1532 % For more details see Section \ref{workingwithrna} 
1533 } \parbox[c]{3in}{
1534 \includegraphics[width=2.75in]{images/col_rnahelix.pdf} }
1535
1536 \exercise{Colouring Alignments}{
1537 \label{color}
1538 Note: Before you begin this exercise, ensure that the {\sl Apply Colour
1539 To All Groups} flag is not selected in {\sl Colour} menu in the alignment window.
1540 % patch needed for 2.10 This must be turned {\sl off} specifically as it is on
1541 % by default.
1542
1543 \exstep{Open a sequence alignment, for example the PFAM domain PF03460 in PFAM
1544 seed database. Select the alignment menu option {\sl Colour $\Rightarrow$
1545 ClustalX} and note the colour change. Now try all the other colour schemes in the {\sl Colour} menu. 
1546 Note that some colour schemes do not colour all residues.}
1547 \exstep{Colour the alignment using {\sl Colour  $\Rightarrow$ Blosum62}. Select a group
1548 of around 4 similar sequences. Use the context menu (right click on the group)
1549 option {\sl Selection $\Rightarrow$ Edit New Group $\Rightarrow$ Group Colour
1550 $\Rightarrow$ Blosum62} to colour the selection. Notice how some residues which
1551 were not coloured are now coloured. The calculations performed for dynamic
1552 colouring schemes like Blosum62 are based on the selected group,
1553 not the whole alignment (this also explains the colouring changes observed in exercise
1554 \ref{exselect} during the group selection step).}
1555 \exstep{Keeping the same selection as before, colour the complete alignment except
1556 the group using {\sl Colour  $\Rightarrow$ Taylor}.
1557 Select the menu option  {\sl Colour  $\Rightarrow$ By Conservation}. 
1558 Slide the selector in the Conservation Colour Increment dialog box from side
1559 to side and observe the changes in the alignment colouring in the selection and in the complete alignment.}
1560 Note: Feature colours overlay residue colouring. The features colours can be
1561 toggled off by going to {\sl View  $\Rightarrow$ Show Sequence Features}.
1562
1563 {\bf See the video at: \url{http://www.jalview.org/training/Training-Videos}.}
1564 }
1565
1566 \subsubsection{User Defined}
1567 This dialog allows the user to create any number of named colour schemes at
1568 will. Any residue may be assigned any colour. The colour scheme can then be
1569 named. If you save the colour scheme, this name will appear on the Colour menu
1570 (Figure \ref{usercol}).
1571
1572
1573 \begin{figure}[htbp]
1574 \begin{center}
1575 \includegraphics[width=2.5in]{images/col_user1.pdf}
1576 \includegraphics[width=2in]{images/col_user2.pdf}
1577 \includegraphics[width=1.75in]{images/col_user3.pdf}
1578 \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).}
1579 \label{usercol}
1580 \end{center}
1581 \end{figure}
1582
1583
1584 \exercise{User Defined Colour Schemes}{
1585 \exstep{Load a sequence alignment. Select the alignment menu option {\sl Colour $\Rightarrow$ User Defined}. A dialog window will open.}
1586 \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.}
1587 \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.}
1588 \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.
1589
1590 {\bf See the video at:
1591 \url{http://www.jalview.org/training/Training-Videos}.}} }
1592
1593 \section{Formatting and Graphics Output}
1594 \label{layoutandoutput}
1595 Jalview is a WYSIWIG alignment editor. This means that for most kinds of graphics output, 
1596 the layout that is seen on screen will be the same as what is outputted in an
1597 exported graphics file.
1598 It is therefore important to pick the right kind of display layout prior to generating figures. 
1599
1600 \subsection{Multiple Alignment Views}
1601
1602 Jalview is able to create multiple independent visualizations of the same underlying alignment - these are called {\sl Views}. Because each view displays the same underlying data, any edits performed in one view will update the alignment or annotation visible in all views.
1603
1604 \parbox[c]{4in}{Alignment views are created using the {\sl View $\Rightarrow$ New View} option of the alignment window or by Pressing [CTRL]-T. This will create a new view with the same groups, alignment layout and display options as the current one. 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 simultaneously in their own separate windows. To delete a group, press [CTRL]-W.}\parbox[c]{2.75in}{
1605 \begin{center}\centerline{
1606 \includegraphics[width=2.5in]{images/mulv_tabs.pdf}}
1607 \end{center}
1608 }
1609
1610 % JBPNote make an excercise on views ?
1611
1612 \subsection{Alignment Layout}
1613 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).
1614
1615 \subsubsection{Wrapped Alignments}
1616 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. 
1617
1618 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. 
1619 \begin{figure}[htbp]
1620 \begin{center}
1621 \parbox[c]{2in}{\includegraphics[width=2in]{images/wrap1.pdf}}
1622 \parbox[c]{4in}{\includegraphics[width=4in]{images/wrap2.pdf}}
1623 \caption{{\bf Wrapping the alignment.}}
1624 \label{wrap}
1625 \end{center}
1626 \end{figure}
1627
1628
1629 \subsubsection{Fonts}
1630
1631 \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.}
1632 \parbox[c]{2in}{\centerline{\includegraphics[width=1.75in]{images/font.pdf}}}
1633
1634 \subsubsection{Numbering and Label Justification}
1635 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.
1636
1637 \subsubsection{Alignment and Group Colouring and Appearance}
1638 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.  
1639
1640 \subsubsection{Highlighting Nonconserved Symbols}
1641 The alignment layout and group sub-menu both contain an option to hide
1642 conserved symbols from the alignment display ({\sl Format $\Rightarrow$ Show
1643 nonconserved } in the alignment window or {\sl Selection $\Rightarrow$ Group
1644 $\Rightarrow$ Show Nonconserved} by right clicking on a group). This mode is useful when working with
1645 alignments that exhibit a high degree of homology, because Jalview will only
1646 display gaps or sequence symbols that differ from the consensus for each
1647 column, and render all others with a `.'.
1648 %TODO add a graphic to illustrate this.
1649 \subsection{Annotation Ordering and Display}
1650 % TODO: describe consensus, conservation, quality user preferences, and group
1651 % annotation preferences.
1652 The annotation lines which appear below the sequence alignment are described in
1653 detail in Section \ref{featannot}. They can be hidden by toggling the {\sl View
1654 $\Rightarrow$ Show Annotations} menu option. Additionally, each annotation line
1655 can be hidden and revealed in the same way as sequences {\sl via} the
1656 pop-up context menu on the annotation name panel (Figure \ref{annot}).
1657 Annotations can be reordered by dragging the annotation line label on the annotation label panel. Placing the
1658 mouse over the top annotation label brings up a resize icon on the left. When this is
1659 displayed, Click-dragging up and down provides more space in the alignment window for viewing the annotations, and less space for the sequence alignment.
1660
1661 \begin{figure}
1662 \begin{center}
1663 \includegraphics[width=2.5in]{images/annot1.pdf}
1664 \includegraphics[width=2.5in]{images/annot2.pdf}
1665 \caption{{\bf Hiding Annotations} Annotations can either be hidden from the {\sl
1666 View} menu (left) or individually from the context menu (right).}
1667 \label{annot}
1668 \end{center}
1669 \end{figure}
1670
1671 \exercise{Alignment Layout}{
1672 \label{exscreen}
1673 \exstep{Start Jalview and open the URL \textsf{http://www.jalview.org/examples/exampleFile.jar}. 
1674 Select {\sl Format $\Rightarrow$ Wrap} from the alignment window menu. 
1675 Experiment with the various options from the {\sl Format} menu, for example adjust the ruler placement, 
1676 sequence ID format and so on. }
1677 \exstep{Hide all the annotation rows by toggling {\sl Annotations $\Rightarrow$
1678 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
1679 annotation row labels to bring up the context menu, then select {\sl
1680 Hide This Row}. Bring up the context menu again and select {\sl
1681 Show All Hidden Rows} to reveal them.}
1682 \exstep{Annotations can be reordered by clicking and dragging the row to the desired position. Click on the {\sl Consensus} row and drag it upwards to just 
1683 above {\sl Quality}. The rows should now be reordered. Features and annotations are covered in more detail in Section \ref{featannot}.}
1684 \exstep{Move the mouse to the top left hand corner of the annotation labels - 
1685 a grey up/down arrow symbol should appear - when this is shown, the height of the {\sl Annotation Area} can be changed 
1686 by clicking and dragging this icon up or down.}
1687 }
1688
1689 \subsection{Graphical Output}
1690 \label{figuregen}
1691 \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. }
1692 \parbox[c]{2in}{\centerline{\includegraphics[width=1.25in]{images/image.pdf}}}
1693
1694 \subsubsection{HTML}
1695
1696 \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.}
1697 \parbox[c]{3.5in}{\centerline{\includegraphics[width=3in]{images/image_html.pdf}}}
1698
1699 \subsubsection{EPS}
1700 \parbox[c]{3in}{EPS is Encapsulated Postscript. {\bf It is the format of choice
1701 for publications and posters} as it gives the highest quality output of any of
1702 the image types. It can be scaled to any size, so will still look good on an A0
1703 poster.
1704 This format can be read by most good presentation and graphics packages such as Adobe Illustrator or Inkscape.
1705 }
1706 \parbox[c]{3.5in}{\centerline{\includegraphics[width=3in]{images/image_eps.pdf}} \par \centerline{Zoom Detail of EPS image.}}
1707
1708 \subsubsection{PNG}
1709 \parbox[c]{3in}{
1710 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.
1711
1712 For submission of alignment figures to journals, please use EPS\footnote{If the journal complains, {\em insist}.}.
1713 }
1714 \parbox[c]{3.5in}{\centerline{\includegraphics[width=3in]{images/image_png.pdf}} \par \centerline{Zoom Detail of PNG image.}}
1715
1716  \exercise{Graphical Output}{
1717 \exstep{Load the example Jalview Jar file in Exercise \ref{exscreen}. 
1718 Customise it how you wish but leave it unwrapped. 
1719 Select {\sl File $\Rightarrow$ Export Image $\Rightarrow$ HTML} from the alignment menu. 
1720 Save the file and open it in your favoured web browser.  }
1721 \exstep{Wrap the alignment and export the image to HTML again. Compare the two
1722 images. (Note that the exported image matches the format displayed in the
1723 alignment window but {\bf annotations are not exported}).}
1724 \exstep{Export the alignment using the {\sl File $\Rightarrow$ Export Image $\Rightarrow$ PNG} menu option. 
1725 Open the file in an image viewer that allows zooming such as Paint or Photoshop (Windows), or Preview (Mac OS X) and zoom in. 
1726 Notice that the image is a bitmap and it becomes pixelated when zoomed. 
1727 (Note that the {\bf annotation lines are included} in the image.)}
1728 \exstep{Export the alignment using the {\sl File $\Rightarrow$ Export Image
1729 $\Rightarrow$ EPS} menu option. Open the file in a suitable program such as
1730 Photoshop, Illustrator, Inkscape, Ghostview, Powerpoint (Windows), or
1731 Preview (Mac OS X). Zoom in and note that the image has near-infinite
1732 resolution.} 
1733 }
1734
1735 % left out for Glasgow 2016
1736 % \newpage
1737
1738 % \section{Summary - the rest of the manual}
1739
1740 % The first few chapters have covered the basics of Jalview operation: from
1741 % starting the program, importing, exporting, selecting, editing and colouring
1742 % aligments, to the generation of figures for publication, presentation and web
1743 % pages.
1744
1745 % The remaining chapters in the manual cover:
1746
1747 % \begin{list}{$\circ$}{}
1748 % \item{Chapter \ref{featannot} covers the creation, manipulation and visualisation
1749 % of sequence and alignment annotation, and retrieval of sequence and feature data
1750 % from databases.}
1751 % \item {Chapter \ref{msaservices} explores the range of multiple alignment
1752 % programs offered via Jalview's web services, and introduces the use of
1753 % AACon for protein multiple alignment conservation analysis.}
1754 % \item {Chapter \ref{alignanalysis} introduces Jalview's built in tools for
1755 % multiple sequence alignment analysis, including trees, PCA, and alignment
1756 % conservation analysis. }
1757 % \item {Chapter \ref{3Dstructure} demonstrates the structure visualization
1758 % capabilities of Jalview.}
1759 % \item {Chapter \ref{proteinprediction} introduces protein sequence based
1760 % secondary structure and disorder prediction tools, including JPred.}
1761 % \item {Chapter \ref{dnarna} covers the special functions and
1762 % visualization techniques for working with RNA alignments and protein coding
1763 % sequences.}
1764 % \item {Chapter \ref{jvwebservices} provides instructions on the
1765 % installation of your own Jalview web services.}
1766 % \end{list}
1767
1768 \chapter{Annotation and Features}
1769 \label{featannot}
1770 Annotations and features are additional information that is
1771 overlaid on the sequences and the alignment.
1772 Generally speaking, annotations reflect properties of the alignment as a
1773 whole, often associated
1774 with columns in the alignment. Features are often associated with specific
1775 residues in the sequence.
1776
1777 Annotations are shown below the alignment in the annotation panel, the
1778 properties are often based on the alignment.
1779 Conversely, sequence features are properties of the individual sequences, so they do not change with the alignment, 
1780 but are shown mapped on to specific residues within the alignment. 
1781
1782 Features and annotation can be interactively created, or retrieved from external
1783 data sources. Webservices like JPred (see \ref{jpred} above) can be used to
1784 analyse a given sequence or alignment and generate annotation for it.
1785
1786
1787 \section{Conservation, Quality and Consensus Annotation}
1788 \label{annotationintro}
1789 Jalview automatically calculates several quantitative alignment annotations
1790 which are displayed as histograms below the multiple sequence alignment columns. 
1791 Conservation, quality and consensus scores are examples of dynamic
1792 annotation, so as the alignment changes, they change along with it.
1793 The scores can be used in the hybrid colouring options to shade the alignments. 
1794 Mousing over a conservation histogram reveals a tooltip with more information.
1795
1796 These annotations can be hidden and deleted via the context menu linked to the
1797 annotation row; but they are only created on loading an alignment. If they are
1798 deleted then the alignment should be saved and then reloaded to restore them.
1799 Jalview provides a toggle to autocalculate a consensus sequence upon editing. This is normally selected by default, but can be turned off for
1800 large alignments {\sl via} the {\sl Calculate $\Rightarrow$ Autocalculate
1801 Consensus} menu option if the interface is too slow.
1802
1803 \subsubsection{Conservation Annotation}
1804
1805 Alignment conservation annotation is quantitative numerical index reflecting the
1806 conservation of the physico-chemical properties for each column of the alignment. 
1807 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), 
1808 with identities scoring highest, and amino acids with substitutions in the same physico-chemical class have next highest score. 
1809 The score for each column is shown below the histogram. 
1810 The conserved columns with a score of 11 are indicated by '*'.
1811 Columns with a score of 10 have mutations but all properties are conserved are marked with a '+'.
1812
1813 \subsubsection{Consensus Annotation}
1814
1815 Alignment consensus annotation reflects the percentage of the different residue
1816 per column. By default this calculation includes gaps in columns, gaps can be ignored via the Consensus label context 
1817 menu to the left of the consensus bar chart. 
1818 The consensus histogram can be overlaid
1819 with a sequence logo that reflects the symbol distribution at each column of
1820 the alignment. Right click on the Consensus annotation row and select the {\sl Show
1821 Logo} option to display the Consensus profile for the group or alignment.
1822 Sequence logos can be enabled by default for all new alignments {\sl via} the
1823 Visual tab in the Jalview desktop's preferences dialog box.
1824
1825 \subsubsection{Quality Annotation}
1826
1827 Alignment quality annotation is an ad-hoc measure of the likelihood of observing
1828 the mutations (if any) in a particular column of the alignment. The quality score is calculated for each column in an alignment by summing, 
1829 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). 
1830 This value is normalised for each column, and then plotted on a scale from 0 to 1.
1831
1832 \subsubsection{Group Associated Annotation}
1833 \label{groupassocannotation}
1834 Group associated consensus and conservation annotation rows reflect the
1835 sequence variation within a particular group. Their calculation is enabled
1836 by selecting the {\sl Group Conservation} or {\sl Group Consensus} options in
1837 the {\sl Annotation $\Rightarrow$ Autocalculated Annotation } submenu of the
1838 alignment window. 
1839
1840 \subsection{Creating User Defined Annotation}
1841
1842 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}).
1843 A dialog box appears. Enter the label to use for this row and a new row will appear.
1844
1845 To create a new annotation, first select all the positions to be annotated on the appropriate row. 
1846 Right-clicking on this selection brings up the context menu which allows the insertion of graphics for secondary structure ({\sl Helix} or {\sl Sheet}), 
1847 text {\sl Label} and the colour in which to present the annotation (Figure \ref{newannot}). On selecting {\sl Label} a dialog box will appear, 
1848 requesting the text to place at that position. After the text is entered, the selection can be removed and the annotation becomes clearly 
1849 visible\footnote{When annotating a block of positions, the text can be partly obscured by the selection highlight. Pressing the  [ESC] key clears 
1850 the selection and the label is then visible.}. Annotations can be coloured or deleted as desired.
1851
1852 \begin{figure}[htbp]
1853 \begin{center}
1854 \includegraphics[width=1.3in]{images/annots1.pdf}
1855 \includegraphics[width=2in]{images/annots2.pdf}
1856 \caption{{\bf Creating a new annotation row.} Annotation rows can be reordered by dragging them to the desired place.}
1857 \label{newannotrow}
1858 \end{center}
1859 \end{figure}
1860
1861 \begin{figure}[htbp]
1862 \begin{center}
1863 \includegraphics[width=2in]{images/annots3.pdf}
1864 \includegraphics[width=2in]{images/annots4.pdf}
1865 \includegraphics[width=2in]{images/annots5.pdf}
1866 \caption{{\bf Creating a new annotation.} Annotations are created from a selection on the annotation row and can be coloured as desired.}
1867 \label{newannot}
1868 \end{center}
1869 \end{figure}
1870
1871 \subsection{Automated Annotation of Alignments and Groups}
1872
1873 On loading a sequence alignment, Jalview will normally\footnote{Automatic
1874 annotation can be turned off in the {\sl Visual } tab in the {\sl Tools
1875 $\Rightarrow$ Preferences } dialog box.} calculate a set of automatic annotation
1876 rows which are shown below the alignment. For nucleotide sequence alignments,
1877 only an alignment consensus row will be shown, but for amino acid sequences,
1878 alignment quality (based on BLOSUM 62) and physicochemical conservation will
1879 also be shown. Conservation is calculated according to Livingstone and
1880 Barton\footnote{{\sl ``Protein Sequence Alignments: A Strategy for the
1881 Hierarchical Analysis of Residue Conservation." } Livingstone C.D. and Barton
1882 G.J. (1993) {\sl CABIOS } {\bf 9}, 745-756}.
1883 Consensus is the modal residue (or {\tt +} where there is an equal top residue).
1884 The inclusion of gaps in the consensus calculation can be toggled by
1885 right-clicking on the Consensus label and selecting {\sl Ignore Gaps in
1886 Consensus} from the pop-up context menu located with consensus annotation row.
1887 Quality is a measure of the inverse likelihood of unfavourable mutations in the alignment. Further details on these
1888 calculations can be found in the on-line documentation.
1889
1890
1891 \exercise{Annotating Alignments}{
1892   \label{annotatingalignex}
1893 \exstep{Load the alignment at \textsf{http://www.jalview.org/tutorial/alignment.fa}. 
1894 Right-click on the {\sl Conservation} annotation row to
1895 bring up the context menu and select {\sl Add New Row}. A dialog box will
1896 appear asking for {\sl Annotation Name} and {\sl Annotation Description}.
1897 Enter ``Iron binding site" and click {\sl OK}. A new, empty, row appears.
1898 }
1899 \exstep{
1900 Navigate to column 97. Move down and on the new annotation row called
1901 ``Iron binding site, select column 97.
1902 Right click at this selection and select {\sl Label} from the context menu.
1903 Enter ``Fe" in the box and click {\sl OK}. Right-click on the selection again
1904 and select {\sl Colour}.
1905 Choose a colour from the colour chooser dialog 
1906 and click {\sl OK}. Press [ESC] to remove the selection.
1907
1908 {\sl Note: depending on your Annotation sort settings, your newly
1909 created annotation row might 'jump' to the top or bottom of the annotation
1910 panel. Just scroll up or down to find it again - the column you marked will
1911 still be selected. }
1912
1913 }
1914 \exstep{ Select columns 70-77 on the annotation row. Right-click and choose {\sl Sheet} from the
1915  context menu. You will be prompted for a label. Enter ``B" and press {\sl OK}. A new line showing the 
1916  sheet as an arrow appears. The colour of the label can be changed but not the colour of the sheet 
1917  arrow. 
1918 }
1919 \exstep{Right click on the title text of annotation row that you just created. 
1920 Select {\sl Export Annotation} in context menu and, in the Export Annotation
1921 dialog box that will open, select the Jalview format and click the {\sl [To Textbox]} button. 
1922
1923 The format for this file is given in the Jalview help. Press [F1] to open it, and find 
1924 the ``Annotations File Format'' entry in the ``Alignment Annotations'' section of the contents 
1925 pane. }
1926
1927 \exstep{Export the file to a text editor and edit the file to change the name of the annotation 
1928 row. Save the file and drag it onto the alignment view.}
1929 \exstep{Add an additional helix somewhere along the row by editing the file and 
1930 re-importing it.
1931
1932 {\sl Hint: Use the Export Annotation function to view what helix annotation looks like in 
1933 a Jalview annotation file.}}
1934 \exstep{Use the {\sl Alignment Window $\Rightarrow$ File $\Rightarrow$ Export Annotations...} 
1935 function to export all the alignment's annotation to a file.}
1936 \exstep{Open the exported annotation in a text editor, and use the Annotation File Format 
1937 documentation to modify the style of the Conservation, Consensus and Quality annotation rows so 
1938 they appear as several lines on a single line graph.
1939
1940 {\sl Hint: You need to change the style of annotation row in the first field of the annotation 
1941 row entry in the file, and create an annotation row grouping to overlay the three quantitative 
1942 annotation rows.}
1943 }
1944 \exstep{{\bf Homework for after you have completed exercise \ref{secstrpredex}:}
1945 \label{viewannotfileex}
1946       
1947 Recover or recreate the secondary structure predictions that you made from
1948 JPred. Use the {\sl File $\Rightarrow$ Export Annotation} function to view the Jnet secondary structure prediction annotation row.
1949
1950 Note the 
1951 SEQUENCE\_REF statements surrounding the row specifying the sequence association for the 
1952 annotation. 
1953 }}
1954
1955
1956 \section{Importing Features from Databases}
1957 \label{featuresfromdb}
1958 Jalview supports feature retrieval from public databases.
1959 It includes built in parsers for Uniprot and ENA (or EMBL) records retrieved
1960 from the EBI. Sequences retrieved from these sources using the sequence fetcher (see
1961 Section \ref{fetchseq}) will already possess features.
1962
1963 \subsection{Sequence Database Reference Retrieval}
1964 \label{fetchdbrefs}
1965 Jalview maintains a list of external database references for each sequence in
1966 an alignment. These are listed in a tooltip when the mouse is moved over the
1967 sequence ID when the {\sl View $\Rightarrow$ Sequence ID Tooltip $\Rightarrow$
1968 Show Database Refs } option is enabled. Sequences retrieved using the sequence
1969 fetcher will always have at least one database reference, but alignments
1970 imported from an alignment file generally have no database references.
1971
1972 \subsubsection{Database References and Sequence Coordinate Systems}
1973
1974 Jalview displays features in the local sequence's coordinate system which is
1975 given by its `start' and `end'. Any sequence features on the sequence will be
1976 rendered relative to the sequence's start position. If the start/end positions
1977 do not match the coordinate system from which the features were defined, then
1978 the features will be displayed incorrectly.
1979
1980 \subsubsection{Viewing and Exporting a Sequence's Database Annotation}
1981
1982 You can export all the database cross references and annotation terms shown in
1983 the sequence ID tooltip for a sequence by right-clicking and selecting the {\sl
1984 [Sequence ID] $\Rightarrow$ Sequence details \ldots} option from the popup
1985 menu.
1986 A similar option is provided in the {\sl Selection} sub-menu allowing you to
1987 obtain annotation for the sequences currently selected. 
1988
1989 \parbox[l]{3.4in}{
1990 The {\sl Sequence Details
1991 \ldots} option will open a window containing the same text as would be shown in
1992 the tooltip window, including any web links associated with the sequence. The
1993 text is HTML, and options on the window allow the raw code to be copied and
1994 pasted into a web page.}
1995 \parbox[c]{3in}{
1996 \centerline{\includegraphics[width=2.2in]{images/seqdetailsreport.pdf}}}
1997
1998 \subsubsection{Automatically Discovering a Sequence's Database References}
1999 Jalview includes a function to automatically verify and update each sequence's
2000 start and end numbering against any of the sequence databases that the {\sl
2001 Sequence Fetcher} has access to. This function is accessed from the {\sl
2002 Webservice $\Rightarrow$ Fetch DB References} sub-menu in the Alignment
2003 window. This menu allows you to query either the set of {\sl Standard
2004 Databases}, which includes EMBL, Uniprot, the PDB, or just a specific datasource from one of the submenus.
2005 When one of the entries from this menu is selected, Jalview will use the ID
2006 string from each sequence in the alignment or in the currently selected set to
2007 retrieve records from the external source. Any sequences that are retrieved are
2008 matched against the local sequence, and if the local sequence is found to be a
2009 sub-sequence of the retrieved sequence then the local sequence's start/end
2010 numbering is updated.  A new database reference mapping is created, mapping the
2011 local sequence to the external database, and the local sequence inherits any
2012 additional annotation retrieved from the database sequence.
2013
2014 The database retrieval process terminates when a valid mapping is found for a
2015 sequence, or if all database queries failed to retrieve a matching sequence.
2016 Termination is indicated by the disappearance of the moving progress indicator
2017 on the alignment window. A dialog box may be shown once it completes which
2018 lists sequences for which records were found, but the sequence retrieved from
2019 the database did not exactly contain the sequence given in the alignment (the
2020 {\sl ``Sequence not 100\% match'' dialog box}).
2021
2022
2023 \subsubsection{The Fetch Uniprot IDs Dialog Box}
2024 \label{discoveruniprotids}
2025 If any sources are selected which refer to Uniprot coordinates as their reference system, 
2026 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}. 
2027 If a sequence is verified, then the start/end numbering will be adjusted to match the Uniprot record. 
2028
2029 \subsubsection{Rate of Feature Retrieval}
2030 Feature retrieval can take some time if a large number of sources are selected
2031 and if the alignment contains a large number of sequences.  
2032 As features are retrieved, they are immediately added to the current alignment view.
2033 The retrieved features are shown on the sequence and can be customised as described previously.
2034
2035
2036 \subsection{Colouring Features by Score or Description
2037 Text}
2038 \label{featureschemes}
2039 Sometimes, you may need to visualize the differences in information carried by
2040 sequence features of the same type. This is most often the case when features
2041 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
2042 features using a graduated colourscheme in order to highlight these variations.
2043 In order to apply a graduated scheme to a feature type, select the `Graduated
2044 colour' entry in the Sequence {\sl Feature Type}'s popup menu, which is opened by
2045 right-clicking the {\sl Feature Type} or {\sl Color} in the {\sl Sequence Feature Settings} dialog box. Two types
2046 of colouring styles are currently supported: the default is quantitative
2047 colouring, which shades each feature based on its score, with the highest
2048 scores receiving the `Max' colour, and the lowest scoring features coloured
2049 with the `Min' colour. Alternately, you can select the `Colour by label'
2050 option to create feature colours according to the description text associated
2051 with each feature. This is useful for general feature types - such as
2052 Uniprot's `DOMAIN' feature - where the actual type of domain is given in the
2053 feature's description.
2054
2055 Graduated feature colourschemes can also be used to exclude low or
2056 high-scoring features from the alignment display. This is done by choosing your
2057 desired threshold type (either above or below), using the drop-down menu in the
2058 dialog box. Then, adjust the slider or enter a value in the text box to set the
2059 threshold for displaying this type of feature.
2060
2061 The feature settings dialog box allows you to toggle between a graduated and
2062 simple feature colourscheme using the pop-up menu for the feature type. When a
2063 graduated scheme is applied, it will be indicated in the colour column for
2064 that feature type - with coloured blocks or text to indicate the colouring
2065 style and a greater than ($>$) or less than ($<$) symbol to indicate when a
2066 threshold has been defined.
2067
2068 \subsection{Using Features to Re-order the Alignment}
2069 \label{featureordering}
2070 The presence of sequence features on certain sequences or in a particular
2071 region of an alignment can quantitatively identify important trends in
2072 the aligned sequences. In this case, it is more useful to
2073 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
2074 dialog box provides two buttons: `Seq sort by Density' and `Seq sort by
2075 Score', that allow you to reorder the alignment according to the number of
2076 sequence features present on each sequence, and also according to any scores
2077 associated with a feature. Each of these buttons uses the currently displayed
2078 features to determine the ordering, but
2079 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
2080 popup menu. Simply right-click the type's style in the Sequence Feature Settings dialog
2081 box, and select one of the {\sl Sort by Score} and {\sl Sort by Density}
2082 options to re-order the alignment. Finally, if a specific region is selected,
2083 then only features found in that region of the alignment will be used to
2084 create the new alignment ordering.
2085 % \exercise{Shading and Sorting Alignments using Sequence Features}{
2086 % \label{shadingorderingfeatsex}
2087
2088 % This exercise is currently not included in the tutorial because no DAS servers
2089 % currently exist that yield per-residue features for any Uniprot sequence. 
2090
2091 % \exstep{Re-load the alignment from \ref{dasfeatretrexcercise}.
2092 % }
2093 % \exstep{Open the
2094 % feature settings panel, and, after first clearing the current
2095 % selection, press the {\em Seq Sort by Density} button a few times.}
2096 % \exstep{Use the DAS fetcher to retrieve the Kyte and Doolittle Hydrophobicity
2097 % scores for the protein sequences in the alignment.
2098 % {\sl Hint: the nickname for the das source is `KD$\_$hydrophobicity'.}}
2099 % \exstep{Change the feature settings so only the hydrophobicity features are
2100 % displayed. Mouse over the annotation and also export and examine the GFF and
2101 % Jalview features file to better understand how the hydrophobicity measurements
2102 % are recorded.}
2103 % \exstep{Apply a {\sl Graduated Colour} to the hydrophobicity annotation to
2104 % reveal the variation in average hydrophobicity across the alignment.}
2105 % \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
2106 % hydrophobicity.}
2107 % \exstep{Save the alignment as a project, for use in exercise
2108 % \ref{threshgradfeaturesex}.} }
2109
2110 % \exercise{Shading alignments with combinations of graduated feature
2111 % colourschemes}{
2112 % \label{threshgradfeaturesex}
2113 % \exstep{Reusing the annotated alignment from exercise
2114 % \ref{shadingorderingfeatsex}, experiment with the colourscheme threshold to
2115 % 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.}
2116 % \exstep{Change the colourscheme so
2117 % that features at the threshold are always coloured grey, and the most
2118 % hydrophobic residues are coloured red, regardless of the threshold value
2119 % ({\em hint - there is a switch on the dialog to do this for you}).}
2120 % \exstep{Enable the Uniprot {\em chain} annotation in the feature settings
2121 % display and re-order the features so it is visible under the hydrophobicity
2122 % annotation.}
2123 % \exstep{Apply a {\sl Graduated Colour} to the {\em chain}
2124 % annotation so that it distinguishes the different canonical names associated
2125 % with the mature polypeptide chains.}
2126 % \exstep{Export the alignment's sequence features using the Jalview and GFF file formats, to see how the different types of graduated feature
2127 % colour styles are encoded. }
2128 % }
2129
2130 \subsection{Creating Sequence Features}
2131 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.
2132
2133 \begin{figure}[htbp]
2134 \begin{center}
2135 \includegraphics[width=2in]{images/feature1.pdf}
2136 \includegraphics[width=2.5in]{images/feature2.pdf}
2137 \includegraphics[width=1.5in]{images/feature3.pdf}
2138 \caption{{\bf Creating sequence features.} Features can readily be created from selections via the context menu and are then displayed on the sequence. }
2139 \label{features}
2140 \end{center}
2141 \end{figure}
2142
2143 Creation of features from a selection spanning multiple sequences results in the creation of one feature per sequence. 
2144 Each feature remains associated with its own sequence.
2145
2146 \subsection{Customising Feature Display}
2147
2148 Feature display can be toggled on or off by selecting the {\sl View
2149 $\Rightarrow$ Show Sequence Features} menu option. When multiple features are
2150 present it is usually necessary to customise the display. Jalview allows the
2151 display, colour, rendering order and transparency of features to be modified
2152 {\sl via} the {\sl View $\Rightarrow$ Feature Settings\ldots} menu option. This
2153 brings up a dialog window (Figure \ref{custfeat}) which allows the
2154 visibility of individual feature types to be selected, colours changed (by
2155 clicking on the colour of each sequence feature type) and the rendering order
2156 modified by dragging feature types to a new position in the list. Dragging the
2157 slider alters the transparency of the feature rendering. The Feature
2158 Settings dialog also includes functions for more advanced feature shading
2159 schemes and buttons for sorting the alignment according to the distribution of
2160 features. These capabilities are described further in sections
2161 \ref{featureschemes} and \ref{featureordering}.
2162
2163 \begin{figure}[htbp]
2164 \begin{center}
2165 \includegraphics[width=4in]{images/features4.pdf}
2166 \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.}
2167 \end{center}
2168 \end{figure}
2169
2170 \begin{figure}[htbp]
2171 \begin{center}
2172 \includegraphics[width=4in]{images/features5.pdf}
2173 \caption{{\bf Customising sequence features.} Features can be recoloured, switched on or off and have the rendering order changed. }
2174 \label{custfeat}
2175 \end{center}
2176 \end{figure}
2177
2178 \subsection{Sequence Feature File Formats}
2179
2180 Jalview supports the widely used GFF tab delimited format\footnote{see
2181 http://www.sanger.ac.uk/resources/software/gff/spec.html} and its own Jalview
2182 Features file format for the import of sequence annotation. Features and
2183 alignment annotation are also extracted from other formats such as Stockholm,
2184 and AMSA. URL links may also be attached to features. See the online
2185 documentation for more details of the additional capabilities of the Jalview
2186 features file.
2187
2188 \exercise{Creating Features}{
2189 \exstep{Open the alignment at \textsf{http://www.jalview.org/tutorial/alignment.fa}. 
2190 We know that the Cysteine residues at columns 97, 102, 105 and 135 are involved in 
2191 iron binding so we will create them as features. Navigate to column 97, sequence 1. 
2192 Select the entire column by clicking in the ruler bar. Then right-click on the selection 
2193 to bring up the context menu and select {\sl Selection $\Rightarrow$ Create Sequence Feature}. 
2194 A dialog box will appear.
2195 }
2196 \exstep{
2197 Enter a suitable Sequence Feature Name  (e.g. ``Iron binding site") in the
2198 appropriate box. Click on the Feature Colour bar to change the colour if
2199 desired, add a short description (``One of four Iron binding Cysteines") and
2200 press {\sl OK}. The features will then appear on the sequences. } \exstep{Roll
2201 the mouse cursor over the new features.
2202 Note that the position given in the tool tip is the residue number, not the column number. 
2203 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.
2204 Roll the mouse over the features and you will see that the feature has moved with the sequence. Delete the gap you created.
2205 }
2206 \exstep{
2207 Add a similar feature to column 102. When the feature dialog box appears, clicking the Sequence Feature 
2208 Name box brings up a list of previously described features. Using the same Sequence Feature Name allows the features to be grouped.}
2209 \exstep{Select {\sl View $\Rightarrow$ Feature Settings\ldots} from the
2210 alignment window menu. The Sequence Feature Settings window will appear. Move
2211 this so that you can see the features you have just created. Click the check
2212 box for ``Iron binding site"  under {\sl Display} and note that display of this
2213 feature type is now turned off. Click it again and note that the features are
2214 now displayed. Close the sequence feature settings box by clicking {\sl OK} or
2215 {\sl Cancel}.} }
2216
2217 \chapter{Multiple Sequence Alignment}
2218 \label{msaservices}
2219 Sequences can be aligned using a range of algorithms provided by JABA web
2220 services, including ClustalW\footnote{{\sl ``CLUSTAL W:
2221 improving the sensitivity of progressive multiple sequence alignment through sequence
2222 weighting, position specific gap penalties and weight matrix choice."} Thompson
2223 JD, Higgins DG, Gibson TJ (1994) {\sl  Nucleic Acids Research} {\bf 22},
2224 4673-80}, Muscle\footnote{{\sl ``MUSCLE: a multiple sequence alignment method
2225 with reduced time and space complexity"} Edgar, R.C.
2226 (2004) {\sl BMC Bioinformatics} {\bf 5}, 113},  MAFFT\footnote{{\sl ``MAFFT: a
2227 novel method for rapid multiple sequence alignment based on fast Fourier
2228 transform"}  Katoh, K., Misawa, K., Kuma, K. and Miyata, T. (2002) {\sl Nucleic
2229 Acids Research} {\bf 30}, 3059-3066.  and {\sl ``MAFFT version 5:
2230 improvement in accuracy of multiple sequence alignment"} Katoh, K., Kuma, K.,
2231 Toh, H. and Miyata, T. (2005) {\sl Nucleic Acids Research} {\bf 33}, 511-518.},
2232 ProbCons,\footnote{PROBCONS: Probabilistic Consistency-based Multiple Sequence
2233 Alignment.
2234 Do, C.B., Mahabhashyam, M.S.P., Brudno, M., and Batzoglou, S.
2235 (2005) {\sl Genome Research} {\bf 15} 330-340.} T-COFFEE\footnote{T-Coffee:
2236 A novel method for multiple sequence alignments. (2000) Notredame, Higgins and
2237 Heringa {\sl JMB} {\bf 302} 205-217} and Clustal Omega.\footnote{Fast, scalable
2238 generation of high-quality protein multiple sequence alignments using Clustal
2239 Omega. Sievers F, Wilm A, Dineen DG, Gibson TJ, Karplus K, Li W, Lopez R,
2240 McWilliam H, Remmert M, Soding J, Thompson JD, Higgins DG (2011) {\sl Molecular
2241 Systems Biology} {\bf 7} 539
2242 \href{http://dx.doi.org/10.1038/msb.2011.75}{doi:10.1038/msb.2011.75}} Of these,
2243 T-COFFEE is slow but accurate. ClustalW is historically
2244 the most widely used. Muscle is fast and probably best for
2245 smaller alignments. MAFFT is probably the best for large alignments,
2246 however Clustal Omega, released in 2011, is arguably the fastest and most
2247 accurate tool for protein multiple alignment.
2248
2249 \section{Performing a multiple sequence alignment}
2250 To run an alignment web service, select the appropriate method from the {\sl
2251 Web Service $\Rightarrow$  Alignment $\Rightarrow$ \ldots} submenu (Figure
2252 \ref{webservices}). For each service you may either perform an alignment with
2253 default settings, use one of the available presets, or customise the parameters
2254 with the `{\sl Edit and Run ..}' dialog box. Once the job is submitted, a
2255 progress window will appear giving information about the job and any errors that
2256 occur. After successful completion of the job, a new alignment window is opened
2257 with the results, in this case an alignment. By default, the new alignment will be
2258 ordered in the same way as the input sequences. Note: many alignment
2259 programs re-order the input during their analysis and place homologous
2260 sequences close together, the MSA algorithm ordering can be recovered
2261 using the `Algorithm ordering' entry within the {\sl Calculate $\Rightarrow$
2262 Sort } sub menu.
2263
2264 \subsection{Realignment to add sequences to an existing alignment}
2265 The re-alignment option is currently only supported by Clustal  
2266 Omega and ClustalW. When performing a re-alignment, Jalview submits the
2267 current selection to the alignment service complete with any existing gaps.
2268 Realignment with ClustalW is useful when one wishes to align
2269 additional sequences to an existing alignment without any further optimisation
2270 to the existing alignment. ClustalO's realignment works by generating a
2271 probabilistic model (a.k.a HMM) from the original alignment, and then realigns
2272 {\bf all} sequences to this profile. For a well aligned MSA, this process
2273 will simply reconstruct the original alignment (with additonal sequences), but
2274 in the case of low quality MSAs, some differences may be introduced.
2275
2276 \begin{figure}[htbp]
2277 \begin{center}
2278 \parbox[c]{1.5in}{\includegraphics[width=1.5in]{images/ws1.pdf}}
2279 \parbox[c]{2.5in}{\includegraphics[width=2.5in]{images/ws2.pdf}}
2280 \parbox[c]{2in}{\includegraphics[width=2in]{images/ws3.pdf}}
2281 \caption{{\bf Multiple alignment via web services} The appropriate method is
2282 selected from the menu (left), a status box appears (centre), and the results
2283 appear in a new window (right).}
2284 \label{webservices}
2285 \end{center}
2286 \end{figure}
2287
2288 \subsection{Alignments of Sequences that include Hidden Regions}
2289 If the view or selected region submitted for alignment contains hidden
2290 regions, then {\bf only the visible sequences will be submitted to the service}.
2291 Furthermore, each contiguous segment of sequences will be aligned independently
2292 (resulting in a number of alignment `subjobs' appearing in the status window).
2293 Finally, the results of each subjob will be concatenated with the hidden regions
2294 in the input data prior to their display in a new window. This approach ensures
2295 that 1) hidden column boundaries in the input data are preserved in the
2296 resulting alignment - in a similar fashion to the constraint that hidden columns
2297 place on alignment editing (see Section \ref{lockededits} and 2) hidden
2298 columns can be used to preserve existing parts of an alignment whilst the
2299 visible parts are locally refined.
2300
2301 \subsection{Alignment Service Limits}
2302 Multiple alignment is a computationally intensive calculation. Some JABA server
2303 services and service presets only allow a certain number of sequences to be
2304 aligned. The precise number will depend on the server that you are using to
2305 perform the alignment. Should you try to submit more sequences than a service
2306 can handle, then an error message will be shown informing you of the maximum
2307 number allowed by the server.
2308
2309 \exercise{Multiple Sequence Alignment}{
2310 \exstep{ Close all windows and open the alignment at {\sf
2311 http://www.jalview.org/tutorial/unaligned.fa}.  Select {\sl
2312 Web Service $\Rightarrow$ Alignment $\Rightarrow$ Muscle with Defaults}. 
2313 A window will open giving the job status. After a short time, a second window will open
2314  with the results of the alignment.} 
2315  \exstep{Return to the first sequence alignment window by clicking on 
2316  the window, and repeat using {\sl ClustalO} (Omega) and {\sl MAFFT}, from the
2317  {\sl Web Service $\Rightarrow$ Alignment} menu, using the same initial
2318  alignment.
2319  Compare them and you should notice small differences. }
2320 \exstep{Select the last three sequences in the MAFFT alignment, and de-align them 
2321 with {\sl Edit $\Rightarrow$ Remove All Gaps}. Press [ESC] to deselect these
2322 sequences. Then submit this view for re-alignment with {\sl ClustalO}.}
2323 \exstep{Return to the alignment window in section (c), use [CTRL]-Z (undo) to
2324 recover the alignment of the last three sequences in this MAFFT alignment.
2325 Once the ClustalO re-alignment has completed, compare the results of
2326 re-alignment of the three sequences with their alignment in the original MAFFT result.}
2327 \exstep{Select columns 60 to 125 in the original MAFFT alignment and hide them,
2328 by right clicking the mouse to bring up context menu.
2329 Select {\sl Web Service $\Rightarrow$ Alignment $\Rightarrow$ Mafft with Defaults} to 
2330 submit the visible portion of the alignment to MAFFT. When the web service job pane appears, 
2331 note that there are now two alignment job status panes shown in the window.}
2332 \exstep{When the MAFFT job has finished, compare the alignment of the N-terminal visible 
2333 region in the result with the corresponding region of the original alignment.}
2334 \exstep {If you wish, 
2335 select and hide a few more columns in the N-terminal region, and submit the alignment to the 
2336 service again and explore the effect of local alignment on the non-homologous parts of the 
2337 N-terminal region.}
2338 {\bf See the video at:
2339 \url{http://www.jalview.org/training/Training-Videos}.}
2340 }
2341
2342 \section{Customising the Parameters used for Alignment}
2343
2344 JABA web services allow you to vary the parameters used when performing a
2345 bioinformatics analysis. For JABA alignment services, this means you are
2346 usually able to modify the following types of parameters:
2347 \begin{list}{$\bullet$}{}
2348 \item{Amino acid or nucleotide substitution score matrix}
2349 \item{Gap opening and widening penalties}
2350 \item{Types of distance metric used to construct guide trees}
2351 \item{Number of rounds of re-alignment or alignment optimisation}  
2352 \end{list}
2353 \begin{figure}[htbc]
2354 \center{
2355 \includegraphics[width=3in]{images/jvaliwsparamsbox.pdf}
2356 \caption{{\bf Jalview's JABA alignment service parameter editing dialog box}.}
2357 \label{jwsparamsdialog} }
2358 \end{figure}
2359
2360 \subsection{Getting Help on the Parameters for a Service}
2361
2362 Each parameter available for a method usually has a short description, which
2363 Jalview will display as a tooltip, or as a text pane that can be opened under
2364 the parameter's controls. In the parameter shown in Figure
2365 \ref{clustalwparamdetail}, the description was opened by selecting the button on the left hand side. Online help for the
2366 service can also be accessed, by right clicking the button and selecting a URL
2367 from the pop-up menu that will open.
2368
2369 \begin{figure}[htbp]
2370 \begin{center}
2371 \includegraphics[width=2.5in]{images/clustalwparamdetail.pdf}
2372 \caption{{\bf ClustalW parameter slider detail}. From the ClustalW {\sl Clustal $\Rightarrow$ Edit settings and run ...} dialog box. }
2373 \label{clustalwparamdetail}
2374 \end{center}
2375 \end{figure} 
2376
2377 \subsection{Alignment Presets}
2378 The different multiple alignment algorithms available from JABA vary greatly in
2379 the number of adjustable parameters, and it is often difficult to identify what
2380 are the best values for the sequences that you are trying to align. For these
2381 reasons, each JABA service may provide one or more presets -- which are
2382 pre-defined sets of parameters suited for particular types of alignment
2383 problem. For instance, the Muscle service provides the following presets:
2384 \begin{list}{$\bullet$}{}
2385 \item Large alignments (balanced)
2386 \item Protein alignments (fastest speed)
2387 \item Nucleotide alignments (fastest speed)
2388 \end{list}
2389
2390 The presets are displayed in the JABA web services submenu, and can also be
2391 accessed from the parameter editing dialog box, which is opened by selecting
2392 the `{\sl Edit settings and run ...}' option from the web services menu. If you have used
2393 a preset, then it will be mentioned at the beginning of the job status file shown
2394 in the web service job progress window.
2395
2396 \subsection{User Defined Presets}
2397 Jalview allows you to create your own presets for a particular service. To do
2398 this, select the `{\sl Edit settings and run ...}' option for your service,
2399 which will open a parameter editing dialog box like the one shown in Figure
2400 \ref{jwsparamsdialog}.
2401
2402 The top row of this dialog allows you to browse the existing presets, and
2403 when editing a parameter set, allows you to change its nickname. As you
2404 adjust settings, buttons will appear at the top of the parameters dialog that
2405 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
2406 description for the parameter set, which will be shown in the tooltip for the
2407 parameter set's entry in the web services menu.
2408
2409 \subsubsection{Saving Parameter Sets}
2410 When creating a custom parameter set, you will be asked for a file name to save
2411 it. The location of the file is recorded in the Jalview user preferences in the
2412 same way as a custom alignment colourscheme, so when Jalview is launched again,
2413 it will show your custom preset amongst the options available for running the
2414 JABA service.
2415
2416
2417 % \exercise{Creating and using user defined presets}{\label{createandusepreseex}
2418 % \exstep{Import the file at
2419 % \textsf{http://www.jalview.org/tutorial/fdx\_unaligned.fa} into jalview.}
2420 % \exstep{Use the `{\slDiscover Database Ids}' function to recover the PDB cross
2421 % references for the sequences.}
2422 % \exstep{Align the sequences using the default ClustalW parameters.}
2423 % \exstep{Use the `{\sl Edit and run..}'
2424 % option to open the ClustalW parameters dialog box, and create a new preset using
2425 % the following settings:
2426 % \begin{list}{$\bullet$}{}
2427 % \item BLOSUM matrix (unchanged)
2428 % \item Gap Opening and End Gap penalties = 0.05
2429 % \item Gap Extension and Separation penalties = 0.05
2430 % \end{list}
2431
2432 % As you edit the parameters, buttons will appear on the dialog box
2433 % allowing you revert your changes or save your settings as a new parameter
2434 % set.
2435
2436 % Before you save your settings, remeber to give them a meaningful name by editing
2437 % the text box at the top of the dialog box.
2438 % }
2439 % \exstep{Repeat the alignment using your new parameter set by selecting it from
2440 % the {\sl ClustalW Presets menu}.} 
2441 % \exstep{These sequences have PDB structures associated with them, so it is
2442 % possible to compare the quality of the alignments.
2443
2444 % Use the {\sl View all {\bf N}
2445 % structures} option to calculate the superposition of 1fdn on 1fxd for both
2446 % alignments (refer to section \ref{superposestructs} for instructions). Which
2447 % alignment gives the best RMSD ? }
2448 % \exstep{Apply the same alignment parameter settings to the example alignment
2449 % (available from \textsf{http://www.jalview.org/examples/uniref50.fa}). 
2450
2451 % Are there differences ? If not, why not ?
2452 % }
2453 % }
2454
2455 \section{Protein Alignment Conservation Analysis}
2456 \label{aacons}
2457 The {\sl Web Service $\Rightarrow$ Conservation} menu controls the computation
2458 of up to 17 different amino acid conservation measures for the current alignment
2459 view. The JABAWS AACon Alignment Conservation Calculation Service, which is used
2460 to calculate these scores, provides a variety of standard measures described by
2461 Valdar in 2002\footnote{Scoring residue conservation. Valdar (2002) {\sl
2462 Proteins: Structure, Function, and Genetics} {\bf 43} 227-241.} as well as an efficient implementation of the SMERFs
2463 score developed by Manning et al. in 2008.\footnote{SMERFS Score Manning et al. {\sl BMC
2464 Bioinformatics} 2008, {\bf 9} 51 \href{http://dx.doi.org/10.1186/1471-2105-9-51}{doi:10.1186/1471-2105-9-51}}
2465
2466 \subsection{Enabling and Disabling AACon Calculations}
2467 When the AACon Calculation entry in the {\sl Web Service $\Rightarrow$
2468 Conservation} menu is ticked, AACon calculations will be performed every time
2469 the alignment is modified. Selecting the menu item will enable or disable
2470 automatic recalculation.
2471
2472 \subsection{Configuring which AACon Calculations are Performed}
2473 The {\sl Web Service $\Rightarrow$ Conservation $\Rightarrow$ Change AACon
2474 Settings ...} menu entry will open a web services parameter dialog for the
2475 currently configured AACon server. Standard presets are provided for quick and
2476 more expensive conservation calculations, and parameters are also provided to
2477 change the way that SMERFS calculations are performed.
2478 AACon settings for an alignment are saved in Jalview projects along with the
2479 latest calculation results.
2480
2481 \subsection{Changing the Server used for AACon Calculations}
2482 If you are working with alignments too large to analyse with the public JABAWS
2483 server, then you will most likely have already configured additional JABAWS
2484 servers. By default, Jalview will chose the first AACon service available from
2485 the list of JABAWS servers available. If available, you can switch to use
2486 another AACon service by selecting it from the {\sl Web Service $\Rightarrow$
2487 Conservation $\Rightarrow$ Switch Server} submenu.
2488
2489 \chapter{Analysis of Alignments}
2490 \label{alignanalysis}
2491 Jalview provides support for sequence analysis in two ways. A number of
2492 analytical methods are `built-in', these are accessed from the {\sl Calculate}
2493 alignment window menu. Computationally intensive analyses are run outside
2494 Jalview {\sl via} web services - and found under the
2495 {\sl Web Service} menu. In this section, we describe the built-in analysis
2496 capabilities common to both the Jalview Desktop and the JalviewLite applet.
2497  
2498 \section{PCA}
2499 Principal components analysis calculations create a spatial
2500 representation of the similarities within the current selection or the whole alignment if no selection has been made. After
2501 the calculation finishes, a 3D viewer displays each sequence as a point in
2502 3D `similarity space'. Sets of similar sequences tend to lie near each other in
2503 this space.
2504 Note: The calculation is computationally expensive, and may fail for very large
2505 sets of sequences - because the JVM has run out of memory. Memory issues, and
2506 how to overcome them, were discussed in Section \ref{memorylimits}.
2507
2508 \subsubsection{What is PCA?}
2509 Principal components analysis is a technique for examining the structure of
2510 complex data sets. The components are a set of dimensions formed from the
2511 measured values in the data set, and the principal component is the one with the
2512 greatest magnitude, or length. The sets of measurements that differ the most
2513 should lie at either end of this principal axis, and the other axes correspond
2514 to less extreme patterns of variation in the data set.
2515 In this case, the components are generated by an eigenvector decomposition of
2516 the matrix formed from the sum of pairwise substitution scores at each aligned
2517 position between each pair of sequences. The basic method is described in the
2518 1995 paper by {\sl G. Casari, C. Sander} and {\sl A. Valencia} \footnote{{\sl
2519 Nature Structural Biology} (1995) {\bf 2}, 171-8.
2520 PMID: 7749921} and implemented at the SeqSpace server at the EBI.
2521
2522 Jalview provides two different options for the PCA calculation. Protein PCAs are
2523 by default computed using BLOSUM 62 pairwise substitution scores, and nucleic
2524 acid alignment PCAs are computed using a score model based on the identity
2525 matrix that also treats Us and Ts as identical, to support analysis of both RNA
2526 and DNA alignments. The {\sl Change Parameters} menu also allows the calculation
2527 method to be toggled between SeqSpace and a variant calculation that is detailed
2528 in Jalview's built in documentation.\footnote{See
2529 \url{http://www.jalview.org/help/html/calculations/pca.html}.}
2530
2531 \subsubsection{The PCA Viewer}
2532
2533 PCA analysis can be launched from the {\sl Calculate $\Rightarrow$ Principal
2534 Component Analysis} menu option. {\bf PCA requires a selection containing at
2535 least 4 sequences}.  A window opens containing the PCA tool (Figure \ref{PCA}).
2536 Each sequence is represented by a small square, coloured by the background
2537 colour of the sequence ID label. The axes can be rotated by clicking and
2538 dragging the left mouse button and zoomed using the $\uparrow$ and $\downarrow$
2539 keys or the scroll wheel of the mouse (if available).  A tool tip appears if the
2540 cursor is placed over a sequence. Sequences can be selected by clicking on them.
2541 [CTRL]-Click can be used to select multiple sequences.
2542
2543 Labels will be shown for each sequence by toggling the {\sl View $\Rightarrow$
2544 Show Labels} menu option, and the plot background colour changed {\sl via} the
2545 {\sl View $\Rightarrow$ Background Colour..} dialog box. A graphical
2546 representation of the PCA plot can be exported as an EPS or PNG image {\sl via}
2547 the {\sl File $\Rightarrow$ Save As $\Rightarrow$ \ldots } submenu.
2548
2549 \exercise{Principal Component Analysis}
2550 { \exstep{Load the alignment at
2551 \textsf{http://www.jalview.org/tutorial/alignment.fa}.}
2552 \exstep{Select the menu option {\sl Calculate $\Rightarrow$ Principal Component
2553 Analysis}.
2554 A new window will open. Move this window within the desktop so that the tree,
2555 alignment and PCA viewer windows are all visible.
2556 Try rotating the plot by clicking and dragging the mouse on the plot in the PCA window.
2557 Note that clicking on points in the plot will highlight the sequences on the
2558 alignment.
2559 } \exstep{ Select {\sl Calculate $\Rightarrow$ Calculate Tree $\Rightarrow$
2560 Neighbour Joining Using BLOSUM62}. A new tree window will appear.
2561 Place the mouse cursor on the tree window so that the
2562 tree partition location will divide the alignment into a number of groups, each of a different colour.
2563 Note how the colour of the sequence ID label matches both the colour of
2564 the partitioned tree and the points in the PCA plot.} 
2565 {\bf See the video at:
2566 \url{http://www.jalview.org/training/Training-Videos}.}
2567 }
2568
2569 \begin{figure}[hbtp]
2570 \begin{center}
2571 \includegraphics[width=2in]{images/PCA1.pdf}
2572 \includegraphics[width=3in]{images/PCA3.pdf}
2573 \caption{{\bf PCA Analysis.} }
2574 \label{PCA}
2575 \end{center}
2576 \end{figure}
2577
2578
2579
2580 \subsubsection{PCA Data Export}
2581 Although the PCA viewer supports export of the current view, the plots produced
2582 are rarely suitable for direct publication. The PCA viewer's {\sl File} menu
2583 includes a number of options for exporting the PCA matrix and transformed points
2584 as comma separated value (CSV) files. These files can be imported by tools such
2585 as {\bf R} or {\bf gnuplot} in order to graph the data.
2586
2587 \section{Trees}
2588 \label{trees}
2589 Jalview can calculate and display trees, providing interactive tree-based
2590 grouping of sequences though a tree viewer. All trees are calculated {\sl via}
2591 the {\sl Calculate $\Rightarrow$ Calculate Tree $\Rightarrow$ \ldots} submenu.
2592 Trees can be calculated from distance matrices determined from \% identity or
2593 aggregate BLOSUM 62 score using either {\sl Average Distance} (UPGMA) or {\sl
2594 Neighbour Joining} algorithms. The input data for a tree is either the selected
2595 region or the whole alignment, excluding any hidden regions.
2596
2597 On calculating a tree, a new window opens (Figure \ref{trees1}) which contains
2598 the tree. Various display settings can be found in the tree window {\sl View}
2599 menu, including font, scaling and label display options. The {\sl File
2600 $\Rightarrow$ Save As} submenu contains options for image and Newick file
2601 export. Newick format is a standard file format for trees which allows them to
2602 be exported to other programs.  Jalview can also read in external trees in
2603 Newick format {\sl via} the {\sl File $\Rightarrow$ Load Associated Tree} menu
2604 option. Leaf names on imported trees will be matched to the associated alignment
2605 - unmatched leaves will still be displayed, and can be highlighted using the
2606 {\sl View $\Rightarrow$ Mark Unlinked Leaves} menu option.
2607
2608
2609 \begin{figure}
2610 \begin{center}
2611 \includegraphics[width=2.5in]{images/trees1.pdf}
2612 \includegraphics[width=2.5in]{images/trees2.pdf}
2613 \includegraphics[width=1.25in]{images/trees4.pdf}
2614 \caption{{\bf Calculating Trees} Jalview provides a range of options 
2615 for calculating trees.
2616 Jalview can also load precalculated trees in Newick format (right).}
2617 \label{trees1}
2618 \end{center}
2619 \end{figure}
2620
2621
2622 Clicking on the tree brings up a cursor across the height of the tree. The
2623 sequences are automatically partitioned and coloured (Figure \ref{trees2}). To
2624 group them together, select the {\sl Calculate $\Rightarrow$ Sort $\Rightarrow$
2625 By Tree Order $\Rightarrow$ \ldots} alignment window menu option and choose the
2626 correct tree. The sequences will then be sorted according to the leaf order
2627 currently shown in the tree view. The coloured background to the sequence IDs
2628 can be removed with {\sl Select $\Rightarrow$ Undefine Groups} from the
2629 alignment window menu. Note that tree partitioning will also remove any groups
2630 and colourschemes on a view, so create a new view ([CTRL-T]) if you wish to
2631 preserve these.
2632
2633 \begin{figure}
2634 \begin{center}
2635 \includegraphics[width=5in]{images/trees3.pdf}
2636 \caption{{\bf Interactive Trees} The tree level cutoff can be used to designate
2637 groups in Jalview.}
2638 \label{trees2}
2639 \end{center}
2640 \end{figure}
2641
2642 %\subsubsection{Multiple Views and Input Data recovery from PCA and Tree Viewers}
2643 % move to ch. 3 ?
2644 %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.
2645
2646 \subsubsection{Recovering input Data for a Tree or PCA Plot Calculation}
2647 \parbox[c]{5in}{
2648 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. 
2649 }
2650 \parbox[c]{1.25in}{\centerline{\includegraphics[width=1.25in]{images/pca_fmenu.pdf}
2651 }}
2652
2653 \subsubsection{Changing the associated View for a Tree or PCA Viewer}
2654 \parbox[c]{4in}{
2655 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. 
2656 } \parbox[c]{3in}{\centerline{
2657 \includegraphics[width=2.5in]{images/pca_vmenu.pdf} }}
2658
2659 \subsection{Tree Based Conservation Analysis}
2660 \label{treeconsanaly}
2661
2662 Trees reflect the pattern of global sequence similarity exhibited by the
2663 alignment, or region within the alignment, that was used for their calculation.
2664 The Jalview tree viewer enables sequences to be partitioned into groups based
2665 on the tree. This is done by clicking within the tree viewer window. Once subdivided, the
2666 conservation between and within groups can be visually compared in order to
2667 better understand the pattern of similarity revealed by the tree and the
2668 variation within the clades partitioned by the grouping. The conservation based
2669 colourschemes and the group associated conservation and consensus annotation
2670 (enabled using the alignment window's {\sl View $\Rightarrow$ Autocalculated
2671 Annotation $\Rightarrow$ Group Conservation} and {\sl Group Consensus} options)
2672 can help when working with larger alignments.
2673
2674 \exercise{Trees}
2675 {Ensure that you have at least 1G memory available in Jalview.
2676
2677 {\sl (Start with link:
2678 \href{http://www.jalview.org/services/launchApp?jvm-max-heap=1G}{http://www.jalview.org/services/launchApp?jvm-max-heap=1G},
2679 or in the Development section of the Jalview web site
2680 (\href{http://www.jalview.org/development/development-builds}{http://www.jalview.org/development/development-builds})
2681 in the table, go to ``latest official build'' row and ``Webstart'' column, click
2682 on ``2G''.)}
2683
2684 \exstep{Open the alignment at \textsf{http://www.jalview.org/tutorial/alignment.fa}. 
2685 Select {\sl Calculate $\Rightarrow$ Calculate Tree $\Rightarrow$ Neighbour
2686 Joining Using BLOSUM62}. A tree window opens.} 
2687 \exstep{Click on the
2688 tree window, a cursor will appear. Note that placing this cursor divides the tree into a number of groups by colour.
2689 Place the cursor to give about 4 groups.}
2690 \exstep{In the alignment window, select
2691 {\sl Calculate $\Rightarrow$ Sort $\Rightarrow$ By Tree Order $\Rightarrow$ Neighbour Joining Tree using BLOSUM62 from... }. The sequences are 
2692 reordered to match the order in the tree and groups are formed implicitly.
2693 Alternatively in the tree window, select {\sl View $\Rightarrow$ Sort Alignment
2694 by Tree}.} 
2695 \exstep{Select {\sl Calculate $\Rightarrow$ Calculate Tree
2696 $\Rightarrow$ Neighbour Joining Using \% Identity}. A new tree window will
2697 appear. The group colouring makes it easy to see the differences between the two
2698 trees calculated by the different methods.}
2699 \exstep{Select from sequence 2
2700 column 60 to sequence 12 column 123. Select  {\sl Calculate $\Rightarrow$ Calculate Tree $\Rightarrow$ Neighbour Joining Using BLOSUM62}.
2701  A new tree window will appear. The tree contains 11 sequences. It has been coloured according to the already
2702  selected groups from the first tree and is calculated purely from the residues
2703  in the selection.}
2704
2705 Comparing the location of individual sequences between the three trees illustrates the importance of selecting appropriate regions of the 
2706 alignment for the calculation of trees.
2707
2708 {\bf See the video at:
2709 \url{http://www.jalview.org/training/Training-Videos}.}
2710 }
2711
2712 \exercise{Pad Gaps in an Alignment}{
2713 \exstep{Open the alignment at \textsf{http://www.jalview.org/tutorial/alignment.fa}. In alignment window, ensure that the {\sl Edit $\Rightarrow$
2714 Pad Gaps } option is {\sl not} ticked, and insert one gap anywhere in the
2715 alignment.}
2716 \exstep{Select {\sl Calculate $\Rightarrow$ Calculate Tree $\Rightarrow$
2717 Neighbour Joining Using BLOSUM62}.
2718
2719 A warning dialog box {\bf ``Sequences not aligned'' } appears because the sequences input to the tree calculation are of different lengths. }
2720
2721 \exstep{Select {\sl Edit $\Rightarrow$ tick Pad Gaps } and perform the
2722 tree calculation again. This time a new tree should appear - because padding
2723 gaps ensures all the sequences are the same length after editing.}
2724 {\sl Pad Gaps } option
2725 can be set in Preferences using
2726 {\sl Tool $\Rightarrow$ Preference $\Rightarrow$ Editing}.
2727
2728 {\bf See the video at:
2729 \url{http://www.jalview.org/training/Training-Videos}.}
2730 }
2731
2732 \exercise{Tree Based Conservation Analysis}{
2733 \label{consanalyexerc}
2734 \exstep{Load the PF03460 PFAM seed alignment using the sequence fetcher. 
2735 Select {\sl Colour $\Rightarrow$ Taylor $\Rightarrow$ By Conservation}, set {\sl Conservation} shading threshold at around 20. }
2736 \exstep{Build a Neighbour joining tree using Select {\sl Calculate $\Rightarrow$ Calculate Tree $\Rightarrow$
2737 Neighbour Joining Using BLOSUM62}.}
2738 \exstep{Use the mouse cursor to select a point on the tree to partition the
2739 alignment into several sections.}
2740 \exstep {Select {\sl View $\Rightarrow$ Sort Alignment By Tree} option in the
2741 tree window to re-order the sequences in the alignment using the calculated
2742 tree.
2743 Examine the variation in colouring between different groups of sequences in the alignment
2744 window. }
2745 \exstep {You may find it easier to browse the alignment if you first uncheck the
2746 {\sl Annotations $\Rightarrow$ Show Annotations} option. Open the
2747 Overview Window within the View menu to aid navigation.}
2748
2749 \exstep{Try changing the colourscheme of the residues in the alignment to
2750 BLOSUM62 (whilst ensuring that {\sl Apply Colour to All Groups} is selected).}
2751 {\sl Note: You may want to save the alignment and tree as a project file, since
2752 it is used in the next set of exercises. }
2753
2754 {\bf See the video at:
2755 \url{http://www.jalview.org/training/Training-Videos}.}
2756 }
2757
2758
2759 \subsection{Redundancy Removal}
2760
2761 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.}.
2762 \begin{figure}
2763 \begin{center}
2764 \includegraphics[width=5.5in]{images/redundancy.pdf}
2765 \end{center}
2766 \label{removeredundancydialog}
2767 \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.}
2768 \end{figure}
2769
2770
2771 \subsection{Subdividing the Alignment According to Specific Mutations}
2772
2773 It is often necessary to explore variations in an alignment that may correlate
2774 with mutations observed in a particular region; for example, sites exhibiting
2775 single nucleotide polymorphism, or residues involved in substrate recognition in
2776 an enzyme. One way to do this would be to calculate a tree using the specific
2777 region, and subdivide it in order to partition the alignment.
2778 However, calculating a tree can be slow for large alignments, and the tree may
2779 be difficult to partition when complex mutation patterns are being analysed. The
2780 {\sl Select $\Rightarrow$ Make groups for selection } function was introduced to
2781 make this kind of analysis easier. When selected, it will use the characters in
2782 the currently selected region to subdivide the alignment. For example, if a
2783 single column is selected, then the alignment (or each group defined on the
2784 alignment) will be divided into groups based on the residue or nucleotide found
2785 at that position. These new groups are annotated with the characters in the
2786 selected region, and Jalview's group based conservation analysis annotation and
2787 colourschemes can then be used to reveal any associated pattern of sequence
2788 variation across the whole alignment.
2789
2790
2791 % These annotations can be hidden and deleted via the context menu linked to the
2792 % annotation row; but they are only created on loading an alignment. If they are
2793 % deleted then the alignment should be saved and then reloaded to restore them.
2794 % Jalview provides a toggle to autocalculate a consensus sequence upon editing.
2795 % This is normally selected by default, but can be turned off for large alignments {\sl via} the {\sl Calculate $\Rightarrow$ Autocalculate
2796 % Consensus} menu option if the interface is too slow.
2797
2798 % \subsubsection{Group Associated Annotation}
2799 % \label{groupassocannotation}
2800 % Group associated consensus and conservation annotation rows reflect the
2801 % sequence variation within a particular group. Their calculation is enabled
2802 % by selecting the {\sl Group Conservation} or {\sl Group Consensus} options in
2803 % the {\sl Annotation $\Rightarrow$ Autocalculated Annotation } submenu of the
2804 % alignment window. 
2805
2806 % \subsubsection{Alignment and Group Sequence Logos}
2807 % \label{seqlogos}
2808
2809 % The consensus annotation row that is shown below the alignment can be overlaid
2810 % with a sequence logo that reflects the symbol distribution at each column of
2811 % the alignment. Right click on the Consensus annotation row and select the {\sl
2812 % Show Logo} option to display the Consensus profile for the group or alignment.
2813 % Sequence logos can be enabled by default for all new alignments {\sl via} the
2814 % Visual tab in the Jalview desktop's preferences dialog box.
2815
2816 \section{Pairwise Alignments}
2817 Jalview can calculate optimal pairwise alignments between arbitrary 
2818 sequences {\sl via} the {\sl Calculate $\Rightarrow$ Pairwise Alignments\ldots} menu option. 
2819 Global alignments of all pairwise combinations of the selected sequences are performed and the results returned in a text box.
2820
2821
2822
2823 \exercise{Remove Redundant Sequences}{
2824
2825 \exstep{Using the alignment generated in the previous exercise (exercise
2826 \ref{consanalyexerc}).
2827 In the alignment window, you may need to deselect groups using Esc key.}
2828
2829 \exstep{In the {\sl Edit} menu select {\sl Remove Redundancy} to open the
2830 Redundancy threshold selection dialog. Adjust the redundancy threshold value, start
2831 at 50 and increase the value to 65. Sequences selected will change colour in the Sequence ID panel. Select ``Remove'' to
2832 remove the sequences that are more than 65\% similar under this alignment.}
2833
2834 \exstep{From the tree window, select {\sl View $\Rightarrow$
2835 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
2836 to recover the sequences. Note that the * symbols disappear from the tree display.}
2837 \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.}
2838 }
2839
2840 \exercise{Group Conservation Analysis}{
2841 \exstep{Re-use or recreate the alignment and tree which you worked with in the
2842 tree based conservation analysis exercise (exercise \ref{consanalyexerc}).} 
2843 \exstep{In the {\sl View} menu in the alignment window, select {\sl New View} to
2844 create a new view. Ensure the annotation panel is displayed ({\sl Show annotation} in {\sl Annotations} menu). Enable the
2845 display of {\sl Group Consensus} option by checking {\sl Group Consensus} in the {\sl Annotation $\Rightarrow$
2846 Autocalculated Annotation } submenu in the alignment window.}
2847 \exstep{Displaying the sequence 
2848 logos will make it easier to see the different residue populations within each
2849 group. Activate the logo by right clicking on the Consensus annotation row to
2850 open the context menu and select the {\sl Show Logo} option.} 
2851 \exstep{In the column alignment ruler, select a column exhibiting about 50\%
2852 conservation that lies within the central conserved region of the alignment.
2853 (Column 74 is used in \href{https://youtu.be/m-PjynicXRg}{the Tree video}).} 
2854 \exstep{Subdivide the alignment
2855 according to this selection using {\sl Select $\Rightarrow$ Make groups for selection}.}
2856 \exstep{Re-order the alignment according to the new groups that have been
2857 defined by selecting {\sl Calculate $\Rightarrow$ Sort $\Rightarrow$
2858 By Group}.
2859
2860 Click on the group annotation row IDs to select groups exhibiting a
2861 specific mutation.}
2862 \exstep{Select another column exhibiting about 50\% conservation
2863 overall, and subdivide the alignment further. Note that the new groups
2864 inherit the names of the original groups, allowing you to identify the
2865 combination of mutations that resulted in the subdivision.}
2866 \exstep{Clear the groups, and try to subdivide the alignment using two
2867 non-adjacent columns.
2868
2869 {\sl Hint: You may need to hide the intervening columns before you can select
2870 both of the columns that you wish to use to subdivide the alignment.}}
2871 \exstep{Switch back to the original view, and experiment with subdividing
2872 the tree groups made in the previous exercise.}
2873 {\bf See the video at:
2874 \url{http://www.jalview.org/training/Training-Videos}.}
2875 }
2876
2877 \begin{figure}[]
2878 \begin{center}
2879 \includegraphics[width=4in]{images/pairwise.pdf}
2880 \caption{{\bf Pairwise alignment of sequences.} Pairwise alignments of three selected sequences are shown in a textbox.}
2881 \label{pairwise}
2882 \end{center}
2883 \end{figure}
2884
2885
2886 % To review, Chapter \ref{featannot} describes the mechanisms provided by
2887 % Jalview for interactive creation of sequence and alignment annotation, and how
2888 % they can be displayed, imported and exported and used to reorder the alignment. Chapter
2889 % \ref{featuresfromdb} discusses the retrieval of database references and
2890 % establishment of sequence coordinate systems for the retrieval and display of
2891 % features from databases and DAS annotation services.
2892 % Chapter \ref{msaservices} describes how to use the range of multiple alignment
2893 % programs provided by JABAWS, and Chapter \ref{aacons} introduces JABAWS AACon
2894 % service for protein multiple alignment conservation analysis.
2895 %  In Chapter \ref{alignanalysis}, you will find
2896 % descriptions and exercises on building and displaying trees, PCA analysis,
2897 % alignment redundancy removal, pairwise alignments and alignment conservation
2898 % analysis. 
2899 % Chapter \ref{wkwithstructure} introduces the structure visualization
2900 % capabilities of Jalview.
2901 % Chapter \ref{protsspredservices} explains how to perform protein secondary
2902 % structure predictions with JPred, and JABAWS protein disorder prediction
2903 % services are introduced in Chapter \ref{protdisorderpred}.
2904 % Chapter \ref{workingwithnuc} describes functions and visualization techniques
2905 % relevant to working with nucleotide sequences, coding region annotation and nucleotide
2906 % sequence alignments.
2907 % Chapter \ref{jvwebservices} introduces the various web based services
2908 % available to Jalview users, and Chapter \ref{jabaservices} explains how to
2909 % configure the Jalview Desktop for access to new JABAWS servers.
2910
2911
2912 % and Section \ref{workingwithrna} covers the visualization,
2913 % editing and analysis of RNA secondary structure.
2914
2915 \chapter{Working with 3D structures}
2916 \label{3Dstructure}
2917 \label{wkwithstructure}
2918 Jalview facilitates the use of 3D structure data for the analysis of alignments
2919 by providing a linked view of structures associated with the aligned sequences.
2920 It also allows sequence, secondary structure and B-factor data to be imported
2921 from structure files, and supports the use of the EMBL-EBI's SIFTS database to
2922 construct accurate mappings between UniProt protein sequences and structures
2923 retrieved from the PDB.
2924
2925 \section{Molecular graphics systems supported by Jalview}
2926 Jalview can interactively view 3D structure using Jmol, a Java based molecular
2927 viewing program\footnote{See the Jmol homepage \url{http://www.jmol.org} for
2928 more information.} integrated with Jalview.\footnote{Earlier
2929 versions of Jalview included MCView - a simple main chain structure viewer.
2930 Structures are visualized as an alpha carbon trace and can be viewed, rotated
2931 and coloured in a structure viewer and the results interpreted on a sequence
2932 alignment.} It also supports the use of UCSF Chimera, a powerful molecular
2933 graphics system that needs separate installation. Jalview can also read PDB and
2934 mmCIF format files directly to extract sequences and secondary structure
2935 information, and retrieve records from the European Protein
2936 Databank (PDBe) using the Sequence Fetcher (see \ref{fetchseq}).
2937
2938 \subsection{Configuring the default structure viewer}
2939 \label{configuring3dviewer}
2940 To configure which viewer is used when creating a new
2941 structure view, open the Structures preferences window {\sl via} {\sl Tools $\Rightarrow$ Preferences\ldots} and
2942 select either JMOL or CHIMERA as the default viewer. If you select Chimera,
2943 Jalview will search for the installed program, and if it cannot be found,
2944 you will be prompted to locate the Chimera binary, or directed to the UCSF
2945 Chimera download page.
2946
2947 \section{Automatic Association of PDB Structures with Sequences}
2948 Jalview can automatically determine which structures are associated with a
2949 sequence via its ID, and any associated database references. To do this, open
2950 the Sequence ID popup menu and select {\sl View 3D Structure}, to open the 3D
2951 Structure Chooser. 
2952 %(Figure\ref{auto}). 
2953
2954 When the structure chooser is first opened, if no database identifiers are
2955 available, Jalview will attempt to discover identifiers for the sequence and from there discover any
2956 associated PDB structures. This can take a few seconds for each sequence and
2957 will be performed for all selected sequences. After this is done, you can see
2958 the added database references in a tool tip by mousing over the sequence
2959 ID\footnote{Tip:
2960 The sequence ID tooltip can often become large for heavily cross referenced sequence IDs. Use the {\sl View $\Rightarrow$ Sequence ID Tooltip $\Rightarrow$ } 
2961 submenu to disable the display of database cross references or non-positional
2962 features. }, now shows the Uniprot ID and any associated PDB structures.
2963
2964 % \begin{figure}[htbp]
2965 % \begin{center}
2966 % %TODO fix formatting
2967 % \begin{center} 
2968 % \includegraphics[width=3.5in]{images/pdbstructurechooser.pdf}
2969 % \end{center}
2970
2971
2972 % \caption{{\bf The PDB Structure Chooser dialog.} }
2973 % \label{auto}
2974 % \end{center}
2975 % \end{figure}
2976
2977 \subsection{Drag-and-Drop Association of PDB Files with Sequences by Filename
2978 Match}
2979 \label{multipdbfileassoc}
2980 If one or more PDB files stored on your computer are dragged from their location
2981 on the file browser onto an alignment window, Jalview will search the alignment
2982 for sequences with IDs that match any of the files dropped onto the alignment.
2983 If it discovers matches, a dialog like the one in Figure
2984 \ref{multipdbfileassocfig} is shown, giving the option of creating associations
2985 for the matches.
2986
2987 If no associations are made, then sequences extracted
2988 from the structure will be simply added to the alignment. However, if only
2989 some of the PDB files are associated, Jalview will raise another dialog box
2990 giving you the option to add any remaining sequences from the PDB structure files not present in
2991 the alignment. This allows you to easily decorate sequences in a newly imported
2992 alignment with any corresponding structures you've already collected in a directory
2993 accessible from your computer.\footnote{We plan to extend this facility in
2994 future so Jalview will automatically search for PDB files matching your
2995 sequence within a local directory. Check out 
2996 \href{http://issues.jalview.org/browse/JAL-801}{Jalview issue 801}}
2997
2998 % 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 ...
2999 % JBP: yes there is - under 'Discovery of ' subsection.
3000 \begin{figure}[htbp]
3001 \begin{center}
3002 \includegraphics[]{images/pdbdragdropassoc.pdf}
3003
3004 \caption{{\bf Associating PDB files with sequences by drag-and-drop.} Dragging
3005 PDB files onto an alignment of sequences with names matching the dragged files
3006 names (A), results in a dialog box (B) that gives the option to associate each
3007 file with any sequences with matching IDs. }
3008 \label{multipdbfileassocfig}
3009 \end{center}
3010 \end{figure}
3011
3012
3013 \section{Viewing Structures}
3014 \label{viewAllStructures}
3015 The structure viewer is launched from the sequence ID context
3016 menu. To view a particular structure associated with a sequence in the
3017 alignment, select the sequence and right click the mouse to open context
3018 menu {\sl Structure $\Rightarrow$ 3D Structure data $\Rightarrow$} opens a Structure Chooser dialog box.
3019 The second way is most useful if you want to view all structural data available for
3020 a set of sequences in an alignment. Select all the sequence ids in the sequence
3021 ID panel and right click the mouse to open context
3022 menu {\sl Structure $\Rightarrow$ 3D Structure data $\Rightarrow$}. If any of
3023 the {\bf currently selected} sequences have structures associated they will
3024 appear in the Structure Chooser dialog box. The structures can be ranked by
3025 different parameters, 'Best Quality' is defaul option. Select the
3026 structures required and click {\sl View} to open a structure viewer containing
3027 the associated structures superposed according to the alignment.
3028
3029 The structure to be displayed will be downloaded or loaded from
3030 the local file system, and shown as a ribbon diagram coloured according to the
3031 associated sequence in the current alignment view (Figure \ref{structure}
3032 (right)). The structure can be rotated by clicking and dragging in the structure
3033 window. The structure can be zoomed using the mouse scroll wheel or by
3034 [SHIFT]-dragging the structure.
3035 Moving the mouse cursor over a sequence to which the structure is linked in the
3036 alignment view highlights the respective residue's sidechain atoms. The
3037 sidechain highlight may be obscured by other parts of the molecule. Similarly,
3038 moving the cursor over the structure shows a tooltip and highlights the
3039 corresponding residue in the alignment. Clicking the alpha carbon or phosphorous
3040 backbone atom will toggle the highlight and residue label on and off. Often, the
3041 position highlighted in the sequence may not be in the visible portion of the
3042 current alignment view and the sliders will scroll automatically to show the
3043 position. If the alignment window's {\sl View $\Rightarrow$ Automatic Scrolling
3044 } option is not selected, however, then the automatic adjustment will be
3045 disabled for the current view.
3046
3047 \begin{figure}[htbp]
3048 \begin{center}
3049 \parbox{3in}{
3050 {\centering 
3051 \begin{center}
3052 \includegraphics[scale=0.5]{images/structure1.pdf}
3053 \end{center}
3054 }
3055 }
3056 \parbox{3.2in}{
3057 {\centering 
3058 \begin{center}
3059 \includegraphics[width=3in]{images/structure2.pdf}
3060 \end{center}
3061 }
3062 }
3063 \caption{{\bf Structure visualization} The structure viewer is launched from the sequence ID context menu (left) and allows the structure to be visualized using the embedded Jmol molecular viewer (right). }
3064 \label{structure}
3065 \end{center}
3066 \end{figure}
3067
3068 \subsection{Customising Structure Display}
3069
3070 Structure display can be modified using the {\sl Colour} and {\sl View} menus
3071 in the structure viewer. The background colour can be modified by selecting the
3072 {\sl Colours $\Rightarrow$ Background Colour\ldots} option.
3073
3074 By default, the structure will be coloured in the same way as the associated
3075 sequence(s) in the alignment view from which it was launched. The structure can
3076 be coloured independently of the sequence by selecting an appropriate colour
3077 scheme from the {\sl Colours} menu. It can be coloured according to the
3078 alignment using the {\sl Colours $\Rightarrow$ By Sequence } option. The image
3079 in the structure viewer can be saved as an EPS or PNG with the {\sl File
3080 $\Rightarrow$ Save As $\Rightarrow$ \ldots} submenu, which also allows the raw
3081 data to be saved as PDB format. The mapping between the structure and the
3082 sequence (how well and which parts of the structure relate to the sequence) can
3083 be viewed with the {\sl File $\Rightarrow$ View Mapping} menu option.
3084
3085 \subsubsection{Using the Jmol Visualization Interface }
3086
3087 Jmol has a comprehensive set of selection and visualization functions that are
3088 accessed from the Jmol popup menu (by right-clicking in the Jmol window or by
3089 clicking the Jmol logo). Molecule colour and rendering style can be manipulated,
3090 and distance measurements and molecular surfaces can be added to the view. It
3091 also has its own ``Rasmol\footnote{See \url{http://www.rasmol.org}}-like'' scripting
3092 language, which is described elsewhere\footnote{Jmol Wiki:
3093 \url{http://wiki.jmol.org/index.php/Scripting}
3094
3095 Jmol Scripting reference:
3096 \url{http://www.stolaf.edu/academics/chemapps/jmol/docs/}}. Jalview utilises the
3097 scripting language to interact with Jmol and to store the state of a Jmol
3098 visualization within Jalview archives, in addition to the PDB data file
3099 originally loaded or retrieved by Jalview. To access the Jmol scripting
3100 environment directly, use the {\sl Jmol $\Rightarrow$ Console} menu option.
3101
3102 If you would prefer to use Jmol to manage structure colours, then select the
3103 {\sl Colours $\Rightarrow$ Colour with Jmol} option. This will disable any
3104 automatic application of colour schemes when new structure data is added, or
3105 when associated alignment views are modified.
3106
3107 \exercise{Viewing Structures with the integrated Jmol
3108 Viewer}{\label{viewingstructex} \exstep{Load the alignment at
3109 \textsf{http://www.jalview.org/examples/exampleFile.jar}.}
3110 \exstep{Right-click on the
3111 sequence ID label of {\sl FER1\_SPIOL} to open
3112 the ID popup menu and select {\sl 3D Structure}. After a short pause, a
3113 Structure Chooser dialog will open for the sequence, listing available
3114 structure data from the PDB. Select { \sl 1A70} from the list and click {\sl
3115 View}.
3116
3117 {\sl The Structure Chooser dialog presents available PDB structures
3118 by querying the EMBL-EBI's PDBe web API. Extra information can be
3119 including in this window by checking boxes in the columns of the ``Customise Displayed Options'' tab}.
3120 % JBP Note: Bug JAL-1238 needs to be fixed ASAP
3121 }
3122 \exstep{By default the Jmol
3123 structure viewer opens in the Jalview desktop. Rotate the molecule by clicking
3124 and dragging in the structure viewing box.
3125 Zoom with the mouse scroll wheel. } 
3126 \exstep{Roll the
3127 mouse cursor along the {\sl FER1\_SPIOL} sequence in the alignment.
3128 Note that if a residue in the sequence maps to one in the structure, a label
3129 will appear next to that residue in the structure viewer.}
3130 \exstep{Move the mouse over the structure. In the Jmol viewer, placing the mouse over a
3131 part of the structure will bring up a tool tip indicating the name and number of that residue.
3132 In the alignment window, the corresponding residue in the sequence is
3133 highlighted in black.}
3134 \exstep{Clicking the alpha carbon toggles the highlight and residue label on and
3135 off.
3136 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. }
3137 \exstep{In the structure viewer menu, select {\sl Colours $\Rightarrow$ Background
3138 Colour\ldots} and choose a suitable colour.
3139 Press {\sl OK} to apply this.}
3140 \exstep{Select {\sl File $\Rightarrow$ Save As $\Rightarrow$ PNG} and save the
3141 image. On your computer, view this with a suitable program. } 
3142 \exstep{Select
3143 {\sl File $\Rightarrow$ View Mapping} from the structure viewer menu.
3144 A new window opens showing the residue by residue alignment between the sequence and the structure.} 
3145 \exstep{Select {\sl File $\Rightarrow$ Save $\Rightarrow$ PDB file} and choose a new filename to save the PDB file. 
3146 Once the file is saved, open the location in your file browser (or explorer
3147 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). 
3148 Verify that you can open and view the associated structure from the sequence ID
3149 context menu's {\sl 3D Structure } submenu in the new alignment window.}
3150
3151 \exstep{In the Jmol window, right click on the structure window and explore the
3152 menu options. Try to change the style of molecular display - for example by
3153 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.} 
3154 \exstep{In the alignment window, use the {\sl File $\Rightarrow$ Save As.. }
3155 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.
3156 Verify that the Jmol display is as it was when you just saved the file.}
3157 {\bf See the video at:
3158 \url{http://www.jalview.org/training/Training-Videos}.}
3159 }
3160
3161 \exercise{Setting Chimera as the default 3D Structure Viewer}{\label{viewingchimera} 
3162 Jalview supports molecular structure
3163 visualization using both Jmol and Chimera 3D viewers. Jmol is the default
3164 viewer, however Chimera can be set up as the default choice from Preferences.
3165
3166 \exstep{First, Chimera must be downloaded and installed on the computer.
3167 Chimera program is available on the UCSF web site \textsf{https://www.cgl.ucsf.edu/chimera/download.html}.}
3168 \exstep{In the desktop menu, select {\sl Tool  $\Rightarrow$ Preferences}. In
3169 the ``{\sl
3170 Structure}'' tab set {\sl Default structure viewer} as {\sl
3171 Chimera}; then click {\sl OK}.} 
3172 \exstep{Close the Jalview program, from the
3173 {\sl Desktop menu} select {\sl Jalview $\Rightarrow$ Quit Jalview}. Then reopen
3174 Jalview, Chimera should open as the default viewer.}
3175 {\sl Note: The Jmol structure viewer sits within the Jalview desktop. However
3176 the Chimera structure viewer sits outside the Jalview desktop and a Chimera
3177 view window sits inside the Jalview desktop.}
3178
3179 {\bf See the video at: \url{http://www.jalview.org/training/Training-Videos}.} }
3180
3181 \subsection{Superimposing Structures}
3182 \label{superposestructs}
3183 Many comparative biomolecular analysis investigations aim to determine if the
3184 biochemical properties of a given molecule are significantly different to its
3185 homologues. When structure data is available, comparing the shapes of molecules
3186 by superimposing them enables substructure that may impart different behaviour
3187 to be quickly identified. The identification of optimal 3D superposition
3188 involves aligning 3D data rather than sequence symbols, but the result can
3189 still be represented as a sequence alignment, where columns indicate positions
3190 in each molecule that should be superposed to recreate the optimal 3D alignment.
3191
3192 Jalview can employ Jmol's 3D fitting routines\footnote{See
3193 \href{http://chemapps.stolaf.edu/jmol/docs/?ver=12.2$\#$compare}{http://chemapps.stolaf.edu/jmol/docs/?ver=12.2$\#$compare}
3194 for more information.} to recreate 3D structure superpositions based on the
3195 correspondences defined by one or more sequence alignments involving structures shown in the Jmol display. Superposition based on the currently displayed alignment view
3196  happens automatically if a
3197 structure is added to an existing Jmol display using 
3198 the {\sl 3D Structure } option in the Sequence ID popup menu to open the
3199 Structure Chooser dialog box.
3200 Select the structures required and select {\sl View}. A new Jmol view
3201 opens containing superposed structures if the current selection contains two or more sequences with associated
3202 structures.
3203
3204 \subsubsection{Obtaining the RMSD for a Superposition}
3205 The RMSD (Root Mean Square Deviation) is a measure of how similar the structures
3206 are when they are superimposed. Figure \ref{mstrucsuperposition} shows a
3207 superposition created during the course of Exercise \ref{superpositionex}. The
3208 parts of each molecule used to construct the superposition are rendered using
3209 the cartoon style, with other parts of the molecule drawn in wireframe. The Jmol
3210 console, which has been opened after the superposition was performed, shows the
3211 RMSD report for the superposition.
3212 Full information about the superposition is also reported on the Jalview
3213 console.\footnote{The Jalview Java Console is opened from {\sl Tools
3214 $\Rightarrow$ Java Console} option in the Desktop's menu bar} This output also
3215 includes the precise atom pairs used to superpose structures.
3216
3217 \subsubsection{Choosing which part of the Alignment is used for Structural
3218 Superposition} Jalview uses the visible part of each alignment view to define
3219 which parts of each molecule are to be superimposed. Hiding a column in a view
3220 used for superposition will remove that correspondence from the set, and will
3221 exclude it from the superposition and RMSD calculation.
3222 This allows the selection of specific parts of the alignment to be used for
3223 superposition. Only columns that define a complete set of correspondences for
3224 all structures will be used for structural superposition, and as a consequence,
3225 the RMSD values generated for each pair of structures superimposed can be
3226 directly compared.
3227
3228 In order to recompute a superposition after changing a view or editing the
3229 alignment, select the {\sl Jmol $\Rightarrow$ Align Structures} menu option.
3230 The {\sl Jmol $\Rightarrow$ Superpose with ..} submenu allows you to choose which of the
3231 associated alignments and views are to be used to create the set of
3232 correspondences. This menu is useful when composing complex superpositions
3233 involving multi-domain and multi-chain complexes, when correspondences may be
3234 defined by more than one alignment.
3235
3236 Note that these menu options appear when you have two or more structures in one Jmol viewer.
3237
3238 \begin{figure}[htbp]
3239 \begin{center}
3240 \includegraphics[width=5.5in]{images/fdxsuperposition.pdf}
3241 \caption{{\bf Superposition of two ferredoxin structures.} The alignment on the
3242 left was used by Jalview to superpose structures associated with the
3243 FER1\_SPIOL and FER1\_MAIZE sequences in the alignment. Parts of each structure
3244 used for superposition are rendered as a cartoon, the remainder rendered in
3245 wireframe. The RMSD between corresponding positions in the structures before and
3246 after the superposition is shown in the Jmol console.}
3247 \label{mstrucsuperposition}
3248 \end{center}
3249 \end{figure}
3250
3251 \subsection{Colouring Structure Data Associated with Multiple Alignments and
3252 Views} Normally, the original view from which a particular structure view was
3253 opened will be the one used to colour structure data. If alignments involving
3254 sequences associated with structure data shown in a Jmol have multiple views, Jalview gives you full control
3255 over which alignment, or alignment view, is used to colour the structure
3256 display. Sequence-structure colouring associations are
3257 changed {\sl via} the {\sl View $\Rightarrow$ Colour by ..} menu, which lists all
3258 views associated with data shown in the embedded Jmol view. A tick is shown beside
3259 views currently used as colouring source, and moving the
3260 mouse over each view will bring it to the front of the alignment display,
3261 allowing you to browse available colour sources prior to selecting one. If the
3262 {\sl Select many views} option is selected, then multiple views can be selected as sources for colouring the
3263 structure data. {\sl Invert selection} and {\sl Select all views} options are also provided to quickly change between multi-view selections.
3264
3265 Note that the {\sl Select many views} option is useful if you have different
3266 views that colour different areas or domains of the alignment. This option is
3267 further explored in Section \ref{complexstructurecolours}.
3268
3269 \begin{figure}[htbp]
3270 \begin{center}
3271 \includegraphics[width=5.5in]{images/mviewstructurecol.pdf}
3272 \caption{{\bf Choosing a different view for colouring a structure display}
3273 Browsing the {\sl View $\Rightarrow$ Colour by ..} menu provides full control
3274 of which alignment view is used to colour structures when the {\sl Colours
3275 $\Rightarrow$ By Sequence} option is selected.}
3276 \label{mviewstructurecol}
3277 \end{center}
3278 \end{figure}
3279
3280 \exercise{Aligning Structures using the Ferredoxin
3281 Sequence Alignment}{\label{superpositionex}
3282
3283 \exstep{Continue with the Jalview project created in exercise
3284 \ref{viewingstructex}}
3285
3286 \exstep{Open the 3D Structure chooser dialog from the popup menu for FER1\_SPIOL
3287 by right-clicking its ID (CMD-click on Macs), and selecting {\sl $\Rightarrow$
3288 3D Structure Data \ldots } }
3289
3290 \exstep{Pick 1A70 from the Structure Chooser dialog, and click the {\bf View}
3291 button. Jalview will give you the option of aligning the
3292 structure to the one already open. To superimpose the structure associated with
3293 FER1\_MAIZE with the one associated with FER1\_SPIOL, press {\sl Yes}.
3294
3295 {\sl The Jmol view should update to show both structures, and one will be
3296 moved on to the other. If this doesn't happen, use the Align function in the
3297 Jmol submenu}.
3298 }
3299
3300 \exstep{Create a new view on the alignment, and hide all but columns 121
3301 through to 132 (you can do this via {\sl View $\Rightarrow$ Hide $\Rightarrow$
3302 All but selected region}).}
3303 \exstep{Select the newly created view in the {\sl Jmol $\Rightarrow$ Superpose
3304 With } submenu, and then recompute the superposition with {\sl Jmol
3305 $\Rightarrow$ Align Structures}.
3306
3307 {\sl Note how the molecules shift position when superposed with only a small
3308 region of the alignment.}}
3309
3310 \exstep{Compare RMSDs obtained when superimposing molecules with
3311 columns 121-132 and with the whole alignment.}
3312
3313 \exstep{The RMSD report can be
3314 viewed by right clicking the mouse on Jmol window, and select {\sl
3315 Console} from the menu (if nothing is shown, recompute the superposition after
3316 displaying the console).
3317
3318 Which view do you think give the best 3D superposition, and why ?} }
3319
3320 \subsubsection{Colouring Complexes}
3321 \label{complexstructurecolours}
3322 The ability to control which multiple alignment view is used to colour
3323 structural data is essential when working with data relating to
3324 multidomain biomolecules and complexes. 
3325
3326 In these situations, each chain identified in the structure may have a different
3327 evolutionary history, and a complete picture of functional variation can
3328 only be gained by integrating data from different alignments on the same
3329 structure view. An example of this is shown in Figure
3330 \ref{mviewalcomplex}, based on data from Song et. al.\footnote{Structure of
3331 DNMT1-DNA Complex Reveals a Role for Autoinhibition in Maintenance DNA Methylation. Jikui Song, Olga Rechkoblit, Timothy H. Bestor, and Dinshaw J. Patel.
3332 {\sl Science} 2011 {\bf 331} 1036-1040
3333 \href{http://www.sciencemag.org/content/331/6020/1036}{DOI:10.1126/science.1195380}}
3334
3335 \begin{figure}[htbp]
3336 \begin{center}
3337 \includegraphics[]{images/mchainstructureview.pdf}
3338 \caption{{\bf The biological assembly of Mouse DNA Methyltransferase-1 coloured
3339 by Pfam alignments for its major domains} Alignments for each domain within the
3340 Uniprot sequence DNMT1\_MOUSE have been used to visualise sequence conservation
3341 in each component of this protein-DNA complex. Instructions for recreating this figure are given in exercise \ref{dnmtcomplexex}. }
3342 \label{mviewalcomplex}
3343 \end{center}
3344 \end{figure}
3345
3346 \exercise{Colouring a Protein Complex to Explore Domain-Domain
3347 Interfaces}{\label{dnmtcomplexex}
3348
3349 \exstep{Download the PDB file at
3350 \textsf{\url{http://www.jalview.org/tutorial/DNMT1\_MOUSE.pdb}} to your desktop. 
3351 This is the biological unit for PDB ID 3pt6, as identified by the PDBe's PISA
3352 server.}
3353 \exstep{Launch the Jalview desktop and ensure you have at least 1G of
3354 free memory available.
3355
3356 {\sl See section \ref{memorylimits} for how to do this or click the following
3357 link:
3358
3359 \url{http://www.jalview.org/services/launchApp?jvm-max-heap=2G} }}
3360
3361 \exstep{Retrieve the following PFAM alignments from the {\bf PFAM (full)} source
3362 :
3363 PF02008 PF01426 PF00145 (enter all three - they
3364 will each be retrieved into their own alignment window).}
3365
3366 \exstep{Drag the URL or file of the structure you
3367 downloaded in step 1 onto one of the alignments to associate it with the mouse sequence in that Pfam domain family.}
3368
3369 \exstep{Use the Find dialog to locate every DNMT1\_MOUSE sequence in the
3370 alignment and for each one, open the Structure Chooser via the ID popup
3371 menu ({\sl $\Rightarrow$ 3D Structure Data }. Select the DNMT1\_MOUSE.pdb
3372 structure from the `Cached Structures' view, and click {\bf View}.
3373
3374 {\em Part of the newly opened structure will be coloured the same way as
3375 the associated DNMT1\_MOUSE sequence is in the alignment view.}
3376
3377 {\bf WARNING: do not select all sequences and open the Structure Chooser
3378 !} {\em This will cause Jalview to attempt to discover all structures for
3379 sequences in the alignment.}
3380 }
3381 \exstep{Repeat the previous two steps for each of the other
3382 alignments. In each case, after selecting the DNMT1\_MOUSE.pdb structure and
3383 hitting the `View' button on the Structure Chooser dialog, Jalview will ask if you wish to create
3384 a new Jmol view. Respond {\bf `Yes'} each time. This will ensure ensure each sequence
3385 fragment is associated with the {\bf same} Jmol view. }
3386
3387 \exstep{Pick a different
3388 colourscheme for each alignment, and use the {\sl Colour by ..} submenu to
3389 ensure they are all used to colour the complex shown in the Jmol window.
3390
3391 {\sl The different shading schemes will allow regions of strong physicochemical conservation are
3392 highlighted on the domains in the structure.}
3393 }
3394
3395 \exstep{The final step needed to reproduce the shading in Figure
3396 \ref{mviewalcomplex} is to use the {\sl Colour $\Rightarrow$ By
3397 Annotation\ldots } option in each alignment window to shade the alignment by the
3398 {\bf Conservation} annotation row (introduced in section
3399 \ref{colourbyannotation}).
3400
3401 Ensure that you first disable the {\sl View $\Rightarrow$ Show Features} menu
3402 option, or you may not see any colour changes in the associated structure.
3403
3404 {\sl Examine the regions strongly coloured at the interfaces betweeen each
3405 protein domain, and the DNA binding region. What do you think these patterns
3406 mean ? } }
3407 \exstep{Save your work as a Jalview project and verify that it can be opened
3408 again by starting another Jalview Desktop instance, and dragging the saved
3409 project into the desktop window.}
3410
3411 % {\sl Note: This exercise relies on new features introduced in Jalview 2.7. If
3412 % you notice any strange behaviour when trying out this exercise, it may be a
3413 % bug (see
3414 % \href{http://issues.jalview.org/browse/JAL-1008}{http://issues.jalview.org/browse/JAL-1008}
3415 % for one relating to highlighting of positions in the alignment window).}
3416 }
3417
3418 % TODO
3419 \chapter{Protein sequence analysis and structure prediction}
3420 \label{proteinprediction}
3421
3422 Many of Jalview's sequence feature and annotation capabilities were developed to
3423 allow the results of sequence based protein structure prediction methods to be
3424 visualised and explored. This chapter introduces services integrated with the
3425 Jalview Desktop for predicting protein secondary structure and protein disorder.
3426
3427 \section{Protein Secondary Structure Prediction}
3428 \label{protsspredservices}
3429 Protein secondary structure prediction is performed using the
3430 Jpred\footnote{{\sl ``The Jpred 3 Secondary Structure Prediction Server''} Cole,
3431 C., Barber, J. D. and Barton, G. J. (2008) {\sl Nucleic Acids Research} {\bf
3432 36}, (Web Server Issue) W197-W201
3433
3434 {\sl ``Jpred: A Consensus Secondary Structure Prediction Server''} Cuff, J. A.,
3435 Clamp, M. E., Siddiqui, A. S., Finlay, M. and Barton, G. J. (1998) {\sl
3436 Bioinformatics} {\bf 14}, 892-893} server at the University of
3437 Dundee\footnote{http://www.compbio.dundee.ac.uk/www-jpred/}. The behaviour of
3438 this calculation depends on the current selection:
3439 \begin{list}{$\circ$}{}
3440 \item If nothing is selected, Jalview will check the length of each alignment row to determine if the visible sequences in the view are aligned.
3441 \begin{list}{-}{}
3442               \item If all rows are the same length (often due to the
3443               application of the {\sl Edit $\Rightarrow$ Pad Gaps} option), then
3444               a JPred prediction will be run for the first sequence in the
3445               alignment, using the current alignment as the profile to use for prediction.
3446               \item  Otherwise, just the first sequence will be submitted for a
3447               full JPred prediction.
3448 \end{list}
3449 \item If just one sequence (or a region in one sequence) has been selected, it
3450 will be submitted to the automatic JPred prediction server for homolog detection
3451 and prediction.
3452 \item If a set of sequences are selected, and they appear to be aligned using
3453 the same criteria as above, then the alignment will be used for a JPred
3454 prediction on the first sequence in the set (that is, the one that appears first in the alignment window).
3455 \end{list}
3456
3457
3458 \begin{figure}[htbp]
3459 \begin{center}
3460 \includegraphics[width=2.25in]{images/jpred1.pdf}
3461 \includegraphics[width=3in]{images/jpred2.pdf}
3462 \caption{{\bf Secondary Structure Prediction} Status (left) and results (right) windows for JNet predictions. }
3463 \label{jpred}
3464 \end{center}
3465 \end{figure}
3466
3467
3468 Jpred is launched in the same way as the other web services. Select {\sl Web
3469 Service $\Rightarrow$ Secondary Structure Prediction $\Rightarrow$ JPred
3470 Secondary Structure Prediction}\footnote{JNet is the Neural Network based
3471 secondary structure prediction method that the JPred server uses.} from the
3472 alignment window menu (Figure \ref{jpred}).
3473 A status window opens to inform you of the progress of the job. Upon completion, a new alignment window opens and the Jpred
3474 predictions are included as annotations. Consult the Jpred documentation for
3475 information on interpreting these results.
3476
3477 \subsection{Hidden Columns and JNet Predictions}
3478 \label{hcoljnet}
3479 Hidden columns can be used to exclude parts of a sequence or profile from the
3480 input sent to the JNet service. For instance, if a sequence is known to include
3481 a large loop insertion, hiding that section prior to submitting the JNet
3482 prediction can produce different results. In some cases, these secondary
3483 structure predictions can be more reliable for sequence on either side of the
3484 insertion\footnote{This, of course, cannot be guaranteed.}. Prediction results
3485 returned from the service will be mapped back onto the visible parts of the
3486 sequence, to ensure a single frame of reference is maintained in your analysis.
3487
3488
3489 \exercise{Secondary Structure Prediction}{
3490 \label{secstrpredex}
3491
3492 {\sl Note: The annotation panel can get quite busy during this exercise. Try
3493 hiding some annotations rows by right clicking
3494 the mouse in the annotation label panel and select the ``Hide this row'' option.
3495 The Annotations dropdown menu on the alignment wndow also provides options for
3496 reording and hiding autocalculated and sequence associated annotation. }
3497
3498 \exstep{ Open the alignment at \url{http://www.jalview.org/tutorial/alignment.fa}. Select the sequence {\sl FER\_MESCR} by 
3499 clicking on the sequence ID. Then select {\sl Web Service $\Rightarrow$
3500 Secondary Structure Prediction $\Rightarrow$ JPred Secondary Structure
3501 Prediction} from the alignment window menu. A status window will appear and after some time (about 2-4 min) a new window with the JPred prediction will appear.
3502 Note that the number of sequences in the results window is many more than in the original alignment as 
3503 JPred performs a PSI-BLAST search to expand the prediction dataset. The results
3504 from the prediction are visible in the annotation panel. JPred secondary
3505 structure prediction annotations are examples of sequence-associated alignment annotation. }
3506 % TODO: check how long this takes - about 2 mins once it gets on the cluster.
3507 \exstep{
3508 Select a different sequence and perform a JPred prediction in the same way.
3509 There will probably be minor differences in the predictions.
3510 }
3511 \exstep{
3512 Select the sequence used in the second sequence prediction by clicking on its
3513 name in the sequence ID panel, and copy {\sl ([CTRL] or [CMD]-C)} and then
3514 paste it {\sl [CTRL] or [CMD]-V)} into the first prediction window.  You
3515 can now compare the two predictions as the annotations associated with the
3516 sequence has also been copied across.
3517 % which is described in Section \ref{seqassocannot} below.
3518 }
3519 \exstep{
3520 Select and hide some columns in one of the alignment profiles that were returned
3521 from the JNet service, and then submit the profile for prediction again.
3522 }
3523 \exstep{
3524 When you get the result, verify that the prediction has not been made for the
3525 hidden parts of the profile (by clicking the mouse on column ruler and right click to open the
3526 context menu and select {\sl Reveal All}), and that the JPred reliability scores
3527 differ from the prediction made on the full profile.
3528 }
3529 \exstep{
3530 In the original alignment that you loaded in step 1, select {\bf all}
3531 sequences, then open the {\sl Sequence ID $\Rightarrow$ Selection } submenu
3532 by right clicking the mouse to open the context menu, and select the {\sl Add
3533 Reference Annotation} option.
3534
3535 {\bf All} the JPred predictions for the sequences will now be visible in the
3536 original alignment window.}
3537
3538 {\bf Homework:} Go back to the last step of exercise \ref{annotatingalignex} and
3539 follow the instructions to view the Jalview annotations file created from the annotations
3540 generated by the JPred server for your sequence.
3541
3542 }
3543
3544
3545 \section{Protein Disorder Prediction}
3546 \label{protdisorderpred}
3547
3548 Disordered regions in proteins were classically thought to correspond to
3549 ``linkers'' between distinct protein domains, but disorder can also play a role in
3550 function. The {\sl Web Service $\Rightarrow$ Disorder} menu in the alignment window
3551 allows access to protein disorder prediction services provided by the configured
3552 JABAWS servers. 
3553
3554
3555 \begin{figure}[htbp]
3556 \begin{center}
3557 \includegraphics[width=5in]{images/disorderpredannot.pdf}
3558 \caption{{\bf Annotation rows for several disorder predictions on a sequence}. A
3559 zoomed out view of a prediction for a single sequence. The sequence is shaded to highlight disordered regions (brown and grey), and the line plots below the Sequence show the raw scores for various disorder predictors. Horizontal lines on each graph mark the level at which disorder predictions become significant. }
3560 \label{alignmentdisorderannot}
3561 \end{center}
3562 \end{figure}
3563
3564
3565 \subsection{Disorder Prediction Results}
3566 Each service operates on sequences in the alignment to identify regions likely
3567 to be unstructured or flexible, or alternately, fold to form globular domains.
3568 As a consequence, disorder predictor results include both sequence features and
3569 sequence associated alignment annotation rows. Section \ref{featannot} describes
3570 the manipulation and display of these data in detail, and Figure
3571 \ref{alignmentdisorder} demonstrates how sequence feature shading and
3572 thresholding (described in Section \ref{featureschemes}) can be used to
3573 highlight differences in disorder prediction across aligned sequences.
3574
3575
3576 \begin{figure}[htbp]
3577 \begin{center}
3578 \includegraphics[width=5in]{images/disorderpred.pdf}
3579 \caption{{\bf Shading alignment by sequence disorder}. Alignment of Interleukin IV homologs coloured with Blosum62 with protein disorder prediction sequence features overlaid, shaded according to their score. Borderline disordered regions appear white, reliable predictions are either Green or Brown depending on the type of disorder prediction. }
3580 \label{alignmentdisorder}
3581 \end{center}
3582 \end{figure}
3583
3584 \subsection{Navigating Large Sets of Disorder Predictions}
3585
3586 Figure \ref{alignmentdisorderannot} shows a single sequence annotated with
3587 a range of disorder predictions. Disorder prediction annotation rows are
3588 associated with a sequence in the same way as secondary structure prediction
3589 results. When browsing an alignment containing large numbers of disorder
3590 prediction annotation rows, clicking on the annotation row label will highlight
3591 the associated sequence in the alignment display, and double clicking will
3592 select that sequence.
3593
3594
3595 \subsection{Disorder Predictors provided by JABAWS 2.0}
3596 For full details of each predictor and the results that Jalview can display,
3597 please consult
3598 \href{http://www.jalview.org/help/html/webServices/proteinDisorder.html}{Jalview's
3599 protein disorder service documentation}. Short descriptions of the methods provided in JABAWS 2.0 are given below:
3600
3601 \subsubsection{DisEMBL}
3602 \href{http://dis.embl.de/}{DisEMBL (Linding et al., 2003)} is a set of machine-learning based predictors trained to
3603 recognise disorder-related annotation found on PDB structures.
3604
3605 \textbf{COILS} Predicts
3606 loops/coils according to DSSP
3607 definitions\footnote{DSSP Classifications of secondary structure are: $\alpha$-helix (H), 310-helix (G), $\beta$-strand (E)
3608 are ordered, and all other states ($\beta$-bridge (B), $\beta$-turn (T), bend (S),
3609 $\pi$-helix (I), and coil (C)) considered loops or coils.}. Features mark range(s) of
3610 residues predicted as loops/coils, and annotation row gives raw value
3611 for each residue. Value over 0.516 indicates loop/coil.
3612
3613 \textbf{HOTLOOPS} constitute a refined subset of \textbf{COILS}, namely those loops with
3614 a high degree of mobility as determined from C$\alpha$ temperature factors (B
3615 factors). It follows that highly dynamic loops should be considered
3616 protein disorder. Features mark range(s) of residues predicted to
3617 be hot loops and annotation row gives raw value for each
3618 residue. Values over 0.6 indicates hot loop.
3619
3620 \textbf{REMARK465} ``Missing
3621 coordinates in X-ray structure as defined by remark465 entries in PDB.
3622 Nonassigned electron densities most often reflect intrinsic disorder,
3623 and have been used early on in disorder prediction.'' Features give
3624 range(s) of residues predicted as disordered, and annotation rows gives
3625 raw value for each residue. Values over 0.1204 indicates disorder.
3626
3627 \subsubsection{RONN {\sl a.k.a.} Regional Order Neural Network}
3628 \href{http://www.strubi.ox.ac.uk/RONN}{RONN} employs an approach
3629 known as the `bio-basis' method to predict regions of disorder in
3630 sequences based on their local similarity with a gold-standard set of
3631 disordered protein sequences. It yields a set of disorder prediction
3632 scores, which are shown as sequence annotation below the alignment.
3633
3634 \textbf{JRonn}\footnote{JRonn denotes the score for this server because JABAWS
3635 runs a Java port of RONN developed by Peter Troshin and distributed as
3636 part of \href{http://www.biojava.org/}{Biojava 3}} Annotation Row gives RONN score for each residue in
3637 the sequence. Scores above 0.5 identify regions of the protein likely
3638 to be disordered.
3639
3640 \subsubsection{IUPred}
3641 \href{http://iupred.enzim.hu/Help.php}{IUPred} employs
3642 an empirical model to estimate likely regions of disorder. There are
3643 three different prediction types offered, each using different
3644 parameters optimized for slightly different applications. It provides
3645 raw scores based on two models for predicting regions of `long
3646 disorder' and `short disorder'. A third predictor identifies regions
3647 likely to form structured domains.
3648
3649 \textbf{Long disorder} Annotation rows predict
3650 context-independent global disorder that encompasses at least 30
3651 consecutive residues of predicted disorder. A 100 residue
3652 window is used for calculation. Values above 0.5 indicates the residue is
3653 intrinsically disordered.
3654
3655 \textbf{Short disorder} Annotation rows predict for short, (and
3656 probably) context-dependent, disordered regions, such as missing
3657 residues in the X-ray structure of an otherwise globular protein.
3658 Employs a 25 residue window for calculation, and includes adjustment
3659 parameter for chain termini which favors disorder prediction at the
3660 ends. Values above 0.5 indicate short-range disorder.
3661
3662 \textbf{Structured domains} are marked with sequence Features. These highlight
3663 likely globular domains useful for structure genomics investigation. Post-analysis of disordered region profile to find continuous regions
3664 confidently predicted to be ordered. Neighbouring regions close to
3665 each other are merged, while regions shorter than the minimal domain
3666 size of at least 30 residues are ignored.
3667
3668 \subsubsection{GLOBPLOT}
3669 \href{http://globplot.embl.de/}{GLOBPLOT} defines regions of
3670 globularity or natively unstructured regions based on a running sum of
3671 the propensity of residues to be structured or unstructured. The
3672 propensity is calculated based on the probability of each amino acid
3673 being observed within well defined regions of secondary structure or
3674 within regions of random coil. The initial signal is smoothed with a
3675 Savitzky-Golay filter, and its first order derivative
3676 computed. Residues for which the first order derivative is positive
3677 are designated as natively unstructured, whereas those with negative
3678 values are structured.
3679
3680 {\bf Disordered region} sequence features are created marking mark range(s) of residues with positive first order derivatives, and 
3681 \textbf{Globular Domain} features mark long stretches of order. \textbf{Dydx} annotation rows give the first order derivative of smoothed score. Values above 0 indicates
3682 residue is disordered. 
3683
3684 \textbf{Smoothed Score and Raw Score} annotation rows give the smoothed and raw scores used to create the differential signal that
3685 indicates the presence of unstructured regions. These are hidden
3686 by default, but can be shown by right-clicking on the alignment
3687 annotation panel and selecting \textbf{Show hidden annotation}.
3688
3689 \exercise{Protein Disorder Prediction}{
3690 %\label{protdispredex}
3691 {\sl Before starting this exercise, make sure you enable the \protect{`Add
3692 Temperature Factor'} option in your {\bf Structures} preferences. }
3693
3694 \exstep{Open the alignment at:
3695 \url{http://www.jalview.org/tutorial/interleukin7.fa}. } 
3696
3697 \exstep{Run the DisEMBL disorder predictor {\slvia} the {\slWeb Service
3698 $\Rightarrow$ Disorder Prediction } submenu.}
3699
3700 \exstep{Select all the sequences, and open the Structure Chooser via the {\sl
3701 Sequence ID $\Rightarrow$ 3D Structure Data\ldots } popup menu. Hit the
3702 {\bf View} button to retrieve and show all PDB structures for the sequences.}
3703
3704 \exstep{Compare the disorder predictions to the structure data by mapping any
3705 available temperature factors to the alignment {\sl via} the {\sl Sequence ID
3706 Popup $\Rightarrow$ Selection $\Rightarrow$ Add reference annotation} option.}
3707
3708 \exstep{Apply the IUPred disorder prediction method.} 
3709 \exstep{Use the {\sl Per
3710 sequence option} in the {\sl Colour $\Rightarrow$ By annotation \ldots} dialog to shade
3711 the sequences by the long and short disorder predictors.
3712
3713 {\sl Note how well the regions predicted to be disordered by the methods agree
3714 with the structure.}
3715 }
3716
3717 }
3718
3719 \chapter{DNA and RNA Sequences}
3720 \label{dnarna}
3721 \section{Working with DNA}
3722 \label{workingwithnuc}
3723 Jalview was originally developed for the analysis of protein sequences, but
3724 now includes some specific features for working with nucleic acid sequences
3725 and alignments. Jalview recognises nucleotide sequences and alignments based on
3726 the presence of nucleotide symbols [ACGT] in greater than 85\% of the
3727 sequences. Built in codon-translation tables can be used to translate ORFs
3728 into peptides for further analysis. EMBL nucleotide records retrieved {\sl via} the
3729 sequence fetcher (see Section \ref{fetchseq}) are also parsed in order to
3730 identify codon regions and extract peptide products. Furthermore, Jalview
3731 records mappings between protein sequences that are derived from regions of a
3732 nucleotide sequence. Mappings are used to transfer annotation between
3733 nucleic acid and protein sequences, and to dynamically highlight regions in
3734 one sequence that correspond to the position of the mouse pointer in another.
3735 %TODO Working with Nucleic acid sequences and structures.
3736 \subsection{Alignment and Colouring}
3737
3738 Jalview provides a simple colourscheme for DNA bases, but does not apply any
3739 specific conservation or substitution score model for the shading of
3740 nucleotide alignments. However, pairwise alignments performed using the {\sl Calculate $\Rightarrow$ Pairwise Alignment
3741 \ldots} option will utilise an identity score matrix to calculate alignment
3742 score when aligning two nucleotide sequences.
3743
3744 \subsubsection{Aligning Nucleic Acid Sequences}
3745
3746 Jalview has limited knowledge of the capabilities of the programs that
3747 are made available to it {\sl via} web services, so it is up to you, the user,
3748 to decide which service to use when working with nucleic acid sequences. The
3749 table shows which alignment programs are most appropriate
3750 for nucleotide alignment. Generally, all will work, but some may be more suited
3751 to your purposes than others. We also note that none of these include
3752 support for taking RNA secondary structure prediction into account when aligning
3753 sequences (but will be providing services for this in the future!) 
3754 \begin{table}{}
3755 \centering
3756 \begin{tabular}{|l|c|l|}
3757 \hline
3758 Program& NA support& Notes\\
3759 \hline
3760 ClustalW& Yes&\begin{minipage}[f]{3in}
3761 Default is to autodetect nucleotide
3762 sequences. Editable parameters include nucleotide substitution matrices and
3763 distance metrics.
3764 \end{minipage}
3765
3766 \\
3767 \hline
3768
3769 Muscle& Yes (treat U as T)&\begin{minipage}[f]{3in}
3770 Default is to autodetect nucleotide
3771 sequences. Editable parameters include nucleotide substitution matrices and
3772 distance metrics.
3773 \end{minipage}
3774
3775 \\
3776 \hline
3777
3778 MAFFT& Yes&\begin{minipage}[f]{3in}
3779 Will autodetect nucleotide sequences and use a hardwired substitution model
3780 (all amino-acid sequence related parameters are ignored). Unknown whether
3781 substitution model treats Uracil specially.
3782 \end{minipage}
3783
3784 \\
3785 \hline
3786
3787 ProbCons& No&\begin{minipage}[f]{3in}
3788 ProbCons has no special support for aligning nucleotide sequences. Whilst an
3789 alignment will be returned, it is unlikely to be reliable.
3790 \end{minipage}
3791
3792 \\
3793 \hline
3794
3795 T-COFFEE& Yes&\begin{minipage}[f]{3in}
3796 Sequence type is automatically detected and an appropriate
3797 parameter set used as required. A range of nucleotide specific
3798 score models are available.\end{minipage}
3799
3800 \\\hline
3801 \end{tabular}
3802 \caption{{\bf JABAWS Alignment programs suitable for aligning nucleic acid
3803 sequences.} All JABAWS alignment services will return an alignment if provided
3804 with RNA or DNA sequences, with varying reliability.}
3805 \label{nucleomsatools}
3806 \end{table}
3807
3808 \subsection{Translate cDNA}
3809
3810 The {\sl Calculate $\Rightarrow$ Translate cDNA} function in the alignment
3811 window is only available when working with a nucleic acid alignment. It uses the standard codon translation table given in the online help documentation to translate a nucleotide alignment, or the currently selected region, into a set of aligned peptide sequences. Any features or annotation present on the nucleotide alignment will also be translated, allowing DNA alignment analysis results to be transferred on to peptide products for further investigation.
3812
3813 \subsection{Linked DNA and Protein Views}
3814
3815 \parbox{3.5in}{
3816 Views of alignments involving DNA sequences are linked to views of alignments containing their peptide products in a similar way to views of protein sequences and views of their associated structures. Peptides translated from cDNA that have been fetched from EMBL records for DNA contigs are linked to their `parent' coding regions. Mousing over a region of the peptide highlights codons in views showing the original coding region.
3817 }\parbox{3in}{
3818 \begin{center}
3819 %\begin{figure}[htbp]
3820
3821 \includegraphics[width=2.8in]{images/cdnatranslinkedwin.pdf}
3822
3823 %\caption{{\bf Linked DNA and Protein Views.} }
3824 %\end{figure}
3825 \end{center}
3826 }
3827
3828
3829 \subsection{Coding Regions from EMBL Records}
3830
3831 Many EMBL records that can be retrieved with the sequence fetcher contain exons.
3832 Coding regions will be marked as features on the EMBL nucleotide sequence, and
3833 Uniprot database cross references will be listed in the tooltip displayed when
3834 the mouse hovers over the sequence ID. Uniprot database cross references
3835 extracted from EMBL records are sequence cross references, and associate a
3836 Uniprot sequence's coordinate system with the coding regions annotated on the
3837 EMBL sequence. Jalview utilises cross-reference information in two ways.
3838 \subsubsection{Retrieval of Protein or DNA Cross References}
3839 The {\sl Calculate $\Rightarrow$ Get Cross References } function is only available when Jalview recognises that there are protein/DNA cross-references present on sequences in the alignment. When selected, it retrieves the cross references from the alignment's dataset (a set of sequence and annotation metadata shared between alignments) or using the sequence database fetcher. This function can be used for EMBL sequences containing coding regions to open the Uniprot protein products in a new alignment window. The new alignment window that is opened to show the protein products will also allow dynamic highlighting of codon positions in the EMBL record for each residue in the protein product(s).
3840
3841 \subsubsection{Retrieval of Protein Features on Coding Regions}
3842
3843 The Uniprot cross-references derived from EMBL records can be used by Jalview to visualize protein sequence features directly on nucleotide alignments.
3844 This is because the database cross references include the sequence coordinate mapping information to correspond regions on the protein sequence with that of the nucleotide contig. 
3845 Jalview will use the Uniprot accession numbers associated with the sequence to retrieve features, and then map them onto the nucleotide sequence's coordinate system using 
3846 the coding region location.
3847
3848 \begin{figure}[htbp]
3849 \begin{center}
3850 \label{dnadasfeatures}
3851 \includegraphics[width=5in]{images/dnadasfeatures.pdf}
3852
3853 \caption{Uniprot and PDB sum features retrieved and mapped onto
3854 coding regions of EMBL record V00488 (an earlier version of Jalview is shown
3855 here).}
3856
3857 \end{center}
3858 \end{figure}
3859
3860 \exercise{Visualizing Protein Features on Coding Regions}
3861 {
3862 \exstep{Use the sequence fetcher to retrieve EMBL record D49489.}
3863 \exstep{Ensure that {\sl View $\Rightarrow$ Show Sequence Features} is checked and change the 
3864 alignment view format to {\sl Wrapped} mode so the distinct exons can be seen.}
3865 \exstep{Open the {\sl DAS Settings} tab in the {\sl Sequence Feature Settings\ldots} 
3866 window {\sl View $\Rightarrow$ Features setting}
3867 and fetch features for D49489 from the Uniprot reference server,
3868 and any additional servers that work with the Uniprot coordinate system.}
3869 \exstep{Mouse over the features retrieved, note that they have been mapped onto the coding regions, and in some cases broken into several parts to cover the distinct exons.}
3870 \exstep{Open a new alignment view containing the Uniprot protein product 
3871 with {\sl Calculate $\Rightarrow$ Get Cross References $\Rightarrow$ Uniprot } 
3872 and examine the database references and sequence features. Experiment with the 
3873 interactive highlighting of codon position for each residue.}
3874 }
3875 % \section{Working with RNA}
3876 % \label{workingwithrna}
3877
3878 % \subsection{RNA specific alignment colourschemes}
3879 % \label{rnacolschemes}
3880
3881 % \subsection{Exploring RNA secondary structure with VARNA}
3882 % \label{varna}
3883
3884 % \subsection{RNA Secondary structure annotation}
3885 % \subsubsection{Interactive creation of RNA secondary structure annotation}
3886 % \label{rnasecstrediting}
3887
3888 % \subsubsection{Import and export of RNA secondary structure annotation}
3889 % \label{rnasecstrio}
3890
3891
3892 % \chapter{Advanced Jalview}
3893
3894 % \section{Customising Jalview}
3895 % \subsection{Setting preferences}
3896
3897 % The Jalview Desktop stores configuration and history information in a file stored in the users home directory, called `.jalview\_properties'. Many of the options stored in this file are presented in the {\sl Desktop $\Rightarrow$ Tools $\Rightarrow$ Preferences\ldots} dialog. These preferences include default settings for : {\bf Visual} layout settings for alignment views and controlling the display of the default alignment, {\bf Connection} preferences such as the standard set of URL paths that are available from the links menu and the URL which is opened when a Sequence's ID is double clicked, {\bf Editing} settings like {\sl Pad Gaps} and autocalculation of consensus, {\bf Output} settings control the degree of meta-information written in alignment files and mode of EPS Figuregeneration, and finally the {\bf Das Settings} which allows the default DAS sources to be configured. 
3898
3899 % \subsection{Adding your own URL links}
3900
3901 % \subsection{Working with Databases and Database Cross References}
3902 % \label{getcrossrefs}
3903
3904 % {\sl Calculations $\Rightarrow$ Get Cross References }
3905
3906 % \section{Jalview IO Interface}
3907 % \subsection{Multiple views}
3908 % \subsection{Annotation files}
3909 % \subsection{Feature files}
3910 % \subsection{Moving sequence associated annotation}
3911 % \subsection{Propagating features}
3912 % \section{Structures}
3913 % \subsection{Working with Modeller files}
3914 % \subsection{Using local PDB files}
3915 % \section{Pairwise alignments}
3916
3917 \section{Working with RNA}
3918 Jalview allows the creation of RNA secondary structure annotation, and includes
3919 the VARNA secondary structure viewer for the display of RNA base pair diagrams.
3920 It also allows the extraction of RNA secondary structure from 3D data when
3921 available.
3922
3923 \subsection{Performing RNA Secondary Structure Predictions}
3924 Secondary structure consensus calculations can be performed by enabling the
3925 VIENNA service {\sl via} the {\sl Web Service $\Rightarrow$ Secondary
3926 Structure} menu. These consensus structures are created by analysing the
3927 covariation patterns in all visible sequences on the alignment. For more
3928 information see the VIENNA documentation.
3929
3930 \begin{figure}[htbp]
3931 \begin{center}
3932 \label{rnaviennaservice}
3933 \includegraphics[width=5in]{images/rnaViennaServiceWindow.pdf}
3934
3935 \caption{Secondary structure consensus calculations can be performed by enabling the
3936 VIENNA service {\sl via} the {\sl Web Service $\Rightarrow$ Secondary
3937 Structure} menu.}
3938
3939 \end{center}
3940 \end{figure}
3941
3942 \begin{figure}[htbp]
3943 \begin{center}
3944 \label{rnaviennaaltpairs}
3945 \includegraphics[width=5in]{images/rnaViennaAlternateProbs.pdf}
3946
3947 \caption{VIENNA can calculate alternate RNA base pairing probabilities. These
3948 are shown in Jalview as tool-tips on the RNA secondary structure probability
3949 score.}
3950
3951 \end{center}
3952 \end{figure}
3953
3954
3955 \exercise{Viewing RNA Structures}
3956 { \label{viewingrnaex}
3957
3958 \exstep{Import RF00162 from the Rfam (Seed) source using {\sl Fetch sequence(s)}
3959 from the Desktop's File menu.} 
3960
3961 \exstep{Select {\sl Colour by RNA Helices} to
3962 shade the alignment by the secondary structure annotation provided by Rfam.}
3963
3964 \exstep{Open VARNA with {\sl Structure $\Rightarrow$ View Structure
3965 $\Rightarrow$ RNA Secondary Structure}.
3966 In the VARNA Structures Manager toggle between (i) secondary structure
3967 (alignment) (with gaps) and (ii) trimmed secondary structure (alignment). 
3968 Explore the difference between trimmed and untrimmed views.
3969 Click on different residues in the VARNA diagram - you should also see them
3970 highlighted and selected in the sequence alignment window.}
3971
3972 \exstep{In the VARNA Structures Manager, right click on display window to
3973 bring up the pop up context menu. Explore the options within the File, Export,
3974 Display and Edit sections.
3975
3976 {\em VARNA views are stored in Jalview project files, in the same way as 3D
3977 structure views produced by Jmol and Chimera.}}
3978
3979 \exstep{Enable the calculation and display of an RNAAliFold secondary structure
3980 prediction for the alignment by selecting {\sl Web Service $\Rightarrow$ Secondary
3981 Structure Prediction $\Rightarrow$ RNAAliFold }.}
3982 % Compare this with the annotationline provided by Rfam.
3983
3984 \exstep{Edit the RNAAliFold calculation settings to show
3985 Base Pair probabilities. Explore how editing the alignment affects the consensus
3986 calculation.}
3987
3988 \exstep{Import 2GIS from the PDB database into a new window with {\sl Fetch
3989 sequence(s)}.}
3990
3991 \exstep{Click on a sequence in Sequence ID panel and select {\sl Structure
3992 $\Rightarrow$ View Structure $\Rightarrow$ 2GIS}, to view the structure in Jmol
3993 window. Click on different residues and located them in the sequence alignment window.}
3994
3995 %\exstep{Add and link a Jmol structure view
3996 %for Bacillus\_amyloliquef.9 for 3NPB (from the PDB). Display the secondary
3997 %structure along-side the consensus structure for the alignment by adding
3998 %reference annotation from the 3D structure.
3999
4000 %{\sl Hint: You need to make sure the RNAview service is enabled in your {\sl
4001 %Structure} preferences to obtain RNA secondary structure annotation from PDB
4002 %files.}}
4003
4004  }
4005
4006 \chapter{Webservices}
4007 \label{jvwebservices}
4008 The term ``Webservices'' refers to a variety of data exchange
4009 mechanisms based on HTTP.\footnote{HTTP: Hyper-Text Transfer Protocol.} 
4010
4011 \parbox[c]{4.5in}{Jalview can exploit public webservices to access databases
4012 remotely, and also submit data to public services by opening pages with your web browser. These types of
4013 services are `one-way', {\sl i.e.} data is either sent to the webservice or
4014 retrieved from it by Jalview. The desktop application can also interact
4015 with `two-way' remote analysis services in order to offload computationally
4016 intensive tasks to High Performance Computing facilities. Most of these two-way
4017 services are provided by {\bf Ja}va {\bf B}ioinformatics {\bf A}nalysis {\bf
4018 W}eb {\bf S}ervice (JABAWS) servers\footnote{See
4019 http://www.compbio.dundee.ac.uk/jabaws for more information and to download
4020 your own server.}, which provides an easily installable system for performing
4021 a range of bioinformatics analysis tasks. }
4022 \parbox[c]{1.75in}{\includegraphics[width=1.65in]{images/wsmenu.pdf}}
4023
4024 \subsection{One-Way Web Services}
4025
4026 There are two types of one way service in Jalview. Database services,
4027 which were introduced in in Section \ref{fetchseq}, provide sequence and
4028 alignment data. They can also be used to add sequence IDs to an alignment
4029 imported from a local file, prior to further annotation retrieval, as described
4030 in Section \ref{featuresfromdb}.
4031 % The final type of one way service are sequence
4032 % and ID submission services.
4033 % exemplified by the `Envision2 Services' provided
4034 % by the ENFIN Consortium\footnote{ENFIN is the European Network for Functional
4035 % INtegration. Please see http://www.enfin.org for more information. }.
4036
4037 % \subsubsection{One-way submission services}
4038 % Jalview can use the system's web browser to submit sets of sequences and
4039 % sequence IDs to web based applications. Single sequence IDs can be passed to
4040 % a web site using the user definable URL links listed under the {\sl
4041 % Links} submenu of the sequence ID popup menu. These are configured
4042 % in the {\sl Connections} tab of the {\sl Preferences} dialog box.
4043
4044 % The Envision 2 services presented in the webservice menu provides are the first
4045 % example of one-way services where multiple sequences or sequence IDs can be
4046 % sent. The {\sl Web service $\Rightarrow$ Envision 2 Services} menu entry
4047 % provides two sub-menus that enable you to submit the sequences or IDs
4048 % associated with the alignment or just the currently selected sequences to one
4049 % of the Envision2 workflows. Selecting any one will open a new browser window on
4050 % the Envision2 web application. The menu entries and their tooltips provide
4051 % details of the Envision2 workflow and the dataset set that will be submitted
4052 % ({\sl i.e.} the database reference type, or associated sequence subset). Please
4053 % note, due to technical limitations, Jalview can currently only submit small
4054 % numbers of sequences to the workflows - if no sequence or ID submissions are
4055 % presented in the submenus, then try to select a smaller number of sequences to
4056 % submit. 
4057
4058 \subsection{Remote Analysis Web Services}
4059 Remote analysis services enable Jalview to use external computational
4060 facilities. There are currently three types of service - multiple sequence
4061 alignment, protein secondary structure prediction, and alignment analysis.
4062 Many of these are provided by JABA servers, which are described at the end of
4063 this section. In all cases, Jalview will construct a job based on the alignment
4064 or currently selected sequences, ask the remote server to run the job, monitor
4065 status of the job and, finally, retrieve the results of the job and display
4066 them. The Jalview user is kept informed of the progress of the job through a
4067 status window.
4068
4069 Currently, web service jobs and their status windows are not stored in Jalview
4070 Project Files\footnote{This may be rectified in future versions.}, so it is
4071 important that you do not close Jalview whilst a job is running. It is also
4072 essential that you have a continuous network connection in order to
4073 successfully use web services from Jalview, since it periodically checks the
4074 progress of running jobs.
4075
4076
4077 \subsection{JABA Web Services for Sequence Alignment and Analysis}
4078 \label{jabaservices}
4079 JABA stands for ``JAva Bioinformatics Analysis'', which is a system developed
4080 by Peter Troshin and Geoff Barton at the University of Dundee for running
4081 computationally intensive bioinformatics analysis programs. A JABA installation
4082 typically provides a range of JABA web services (JABAWS) for use by other
4083 programs, such as Jalview.
4084
4085 Exercises in the remainder of this section will demonstrate the simplest way of
4086 installing JABA on your computer, and configuring Jalview so it can access the JABA services. If you
4087 need any further help or more information about the services, please go to the
4088 \href{http://www.compbio.dundee.ac.uk/jabaws}{JABAWS home page}.
4089 %% \subsubsection{Aims}
4090 %%  \begin{list}{$\bullet$}{}
4091 %%  \item Gain experience using the different alignment services provided by
4092 % JABA
4093 %%\item Learn about the way that Jalview stores user presets for JABA services
4094 %%\item Learn how to install JABA services and configure Jalview to access them
4095 %%\end{list}
4096
4097 \subsection{Changing the Web Services Menu Layout}
4098 \label{changewsmenulayout}
4099 If you are working with a lot of different JABA services, you may wish to change
4100 the way Jalview lays out the web services menu. You can do this from the Web
4101 Services tab of the {\sl Preferences} dialog box.
4102
4103 \exercise{Changing the Layout of the Web Services Menu}{
4104 \label{changewsmenulayoutex}
4105 \exstep{Make sure you have loaded an alignment into Jalview, and examine the
4106 current layout of the alignment window's {\sl Web Service} menu.}
4107 \exstep{Open the preferences dialog box and select the web services tab.}
4108 \exstep{Ensure the {\sl Enable JABAWS services} checkbox is selected, and unselect
4109 the {\sl Enable Enfin Services} checkboxes.}
4110 \exstep{Hit {\sl Refresh Services} to update the web services menu -- once the
4111 progress bar has completed, open the {\sl Web Service} menu to view the changes.}
4112 \exstep{Select the {\sl Index by host} checkbox and refresh the services once again.
4113
4114 {\sl Observe the way the layout of the JABAWS Alignment submenu changes.}
4115 }
4116 \exstep{Do the same with the {\sl Index by type} checkbox.} 
4117 }
4118
4119 Jalview provides these options for configuring the layout of the  {\sl Web Service}
4120 menu because different Jalview users may have access to a different number of
4121 JABA services, and each will have their own preference regarding the layout of
4122 the menu.
4123
4124 \begin{figure}[htbc]
4125 \begin{center}
4126 \includegraphics[width=3in]{images/jvjabawsconfig.pdf}
4127 \caption{{\bf The Jalview Web Services preferences panel.} Options are provided
4128 for configuring the list of JABA servers that Jalview will use, enabling and
4129 disabling Enfin services, and configuring the layout of the web services
4130 menu.}
4131 \label{jvjabawsconfig}
4132 \end{center}
4133 \end{figure}
4134
4135
4136 \subsubsection{Testing JABA services}
4137 The JABAWS configuration dialog shown in Figure \ref{jvjabawsconfig} has colour
4138 codes to indicate whether the Desktop can access the server, and whether all
4139 services advertised by the server are functional. The colour codes are:
4140
4141 \begin{list}{$\bullet$}{}
4142   \item Red - Server cannot be contacted or reports a connection error.
4143   \item Amber - Jalview can connect, but one or more services are non-functional.
4144   \item Green - Server is functioning normally.
4145 \end{list}
4146   %TODO green and a tick, red and a cros, amber and a value indicating whether its all going
4147
4148 Test results from JABAWS are reported on Jalview's console output (opened from
4149 the Tools menu). Tests are re-run every time Jalview starts, and when the
4150 [Refresh Services] button is pressed on the Jalview JABAWS configuration panel.
4151
4152 \subsubsection{Resetting the JABA Services Setting to their Defaults}
4153 Once you have configured a JABAWS server and selected the OK button of the
4154 preferences menu, the settings will be stored in your Jalview preferences file,
4155 along with any preferences regarding the layout of the web services menu. If
4156 you should ever need to reset the JABAWS server list to its defaults, use the
4157 `Reset Services' button on the Web Services preferences panel.
4158
4159 \subsection{Running your own JABA Server}
4160 You can download and run JABA on your own machine using the `VMWare' or
4161 VirtualBox virtual machine environments. If you would like to learn how to do
4162 this, there are full instructions at the
4163 \href{http://www.compbio.dundee.ac.uk/jabaws/}{JABA web site}.
4164
4165 \exercise{Installing a JABA Virtual Machine on your Computer}{
4166 \label{jabawsvmex}{\sl This tutorial will demonstrate the simplest way of
4167 installing JABA on your computer, and configuring Jalview so it can access the JABA services. 
4168
4169 {\bf Prerequisites}
4170
4171 You will need a copy of VMWare Player/Workstation/Fusion on your machine.
4172 }
4173
4174 \exstep{If you do not have VMWare player installed, download it from
4175 www.vmware.com (this takes a few minutes -- you will need to register and wait
4176 for an email with a download link).}
4177 \exstep{Download the JABA virtual appliance archive called `jaba-vm.zip' from
4178 \textsf{http://www.compbio.dundee.ac.uk/jabaws/archive/jabaws-vm.zip}
4179
4180 WARNING: This is large (about 300MB) and will take some time to download.
4181 }
4182 \exstep{Unpack the archive's contents to a place on your machine with at least
4183 2GB of free space.
4184
4185 (On Windows, right click on the archive, and use the 'Extract archive..' option).
4186 }
4187 \exstep{Open the newly extracted directory and double click the VMWare virtual
4188 machine configuration file (jabaws.vcf). This will launch the VMWare player.
4189 }
4190 \exstep{Once VMWare player has started up, it may ask the question ``Did you move or copy
4191 this virtual appliance?'' -- select `Copy'.}
4192 \exstep{You may be prompted to download the VMWare linux tools. These are not
4193 necessary, so close the window or click on `Later'.}
4194 \exstep{You may also be prompted to install support for one or more devices (USB
4195 or otherwise). Say `No' to these options.}
4196 \exstep{Once the machine has loaded, it will display a series of IP addresses
4197 for the different services provided by the VM. Make a note of the JABAWS URL --
4198 this will begin with `http:' and end with `/jabaws''.}
4199 }
4200
4201 \exercise{Configuring Jalview to Access your new JABAWS Virtual Appliance}{
4202 \label{confnewjabawsappl}
4203 \exstep{Start Jalview (If you have not done so already).} 
4204 \exstep{Enable the Jalview Java Console by selecting its option from the Tools
4205 menu.
4206
4207 {\sl Alternately, use the System Java console if you have
4208 configured it to open when Jalview is launched, {\sl via} your system's Java
4209 preferences (under the `Advanced' tab on Windows).}}
4210 \exstep{Open the {\sl Preferences} dialog and locate the Web Services tab.}
4211 \exstep{Add the URL for the new JABAWS server you started in Exercise
4212 \ref{jabawsvmex} to the list of JABAWS urls using the `New Service
4213 URL' button.}
4214 \exstep{You will be asked if you want to test the service. Hit `Yes' to do this
4215 -- you should then see some output in the console window.
4216
4217 {\sl Take a close look at the output in the console.  What do you think is
4218 happening?}
4219 }
4220 \exstep{Hit OK to save your preferences -- you have now added a new JABA
4221 service to Jalview!}
4222 \exstep{Try out your new JABA services by loading the ferredoxin sequences from
4223 http://www.jalview.org/tutorial/alignment.fa}
4224 \exstep{Launch an alignment using one
4225 of the JABA methods provided by your server. It will be listed under the JABAWS Alignment submenu of the {\sl Web Service} menu on the alignment window.
4226
4227 {\sl Note: You can watch the JABA VM appliance's process working by opening the
4228 process monitor on your system. (On Windows XP, this involves right-clicking the
4229 system clock and opening the task manager -- then selecting the 'Processes' tab
4230 and sort by CPU).}
4231 }
4232 }
4233
4234 \end{document}