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