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