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