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