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