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