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