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