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