1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
|
<?xml version='1.0' encoding='ISO-8859-1'?>
<?xml-stylesheet type="text/xsl"
href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"/usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [
<!ENTITY dhfirstname "Charles">
<!ENTITY dhsurname "Plessy>">
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "charles-debian-nospam@plessy.org">
<!ENTITY dhusername "&dhfirstname; &dhsurname;">
<!ENTITY dhucpackage "<refentrytitle>AMAP</refentrytitle>">
<!ENTITY dhpackage "amap">
<!ENTITY dhrelease "2.2">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
<!ENTITY dhtitle "User Manual">
]>
<!-- This manpage is inspired from the template of docbook-xsl 1.71.0.dfsg.1-1.1 -->
<refentry>
<refentryinfo>
<title>&dhtitle;</title>
<productname>&dhpackage;</productname>
<releaseinfo role="version">&dhrelease;</releaseinfo>
<authorgroup>
<author>
<firstname>Ariel</firstname>
<surname>Schwartz</surname>
<contrib>Upstream author of AMAP</contrib>
<address>
<email>sariel@cs.berkeley.edu</email>
</address>
</author>
<author>
<firstname>Chuong</firstname>
<surname>Do</surname>
<contrib>Wrote Probcons, on which AMAP is based.</contrib>
</author>
<author>
<firstname>&dhfirstname;</firstname>
<surname>&dhsurname;</surname>
<contrib>Wrote this manpage in DocBook XML for the Debian distribution.</contrib>
<address>
<email>&dhemail;</email>
</address>
</author>
</authorgroup>
<legalnotice>
<para>
AMAP, PROBCONS, and this manual page have been made freely available as PUBLIC DOMAIN software and hence are not subject to copyright in the United States. This system and/or any portion of the source code may be used, modified, or redistributed without restrictions. AMAP, PROBCONS and this manual page are distributed WITHOUT WARRANTY, express or implied. The authors accept NO LEGAL LIABILITY OR RESPONSIBILITY for loss due to reliance on the program.
</para>
</legalnotice>
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>amap</refname>
<refpurpose>Protein multiple alignment by sequence annealing</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>amap</command>
<arg choice="opt"><option><replaceable>OPTION</replaceable></option></arg>
<arg><replaceable>MFAFILE</replaceable></arg>
<arg choice="opt"><replaceable>MFAFILE</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>AMAP is a tool to perform multiple alignment of peptidic sequences. It utilizes posterior decoding, and a sequence-annealing alignment, instead of the traditional progressive alignment method. It is the only alignment program that allows to control the sensitivity / specificity tradeoff. It is based on the ProbCons source code, but uses alignment metric accuracy and eliminates the consistency transformation.</para>
<para>In its default configuration, AMAP is tuned to maximize the expected Alignment Metric Accuracy (AMA) score - a new alignment accuracy measure, based on a metric for the multiple-alignment space, which integrates sensitivity and specificity into a single balanced measure. AMA is defined as the fraction of correctly aligned residues (either to another residue or to a gap) out of the total number of residues in all the sequences.</para>
<para><command>&dhpackage;</command> aligns sequences provided in MFA format. This format consists of multiple sequences. Each sequence in MFA format begins with a single-line description, followed by lines of sequence data. The description line is distinguished from the sequence data by a greater-than (<quote>></quote>) symbol in the first column.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>-clustalw</option>
</term>
<listitem>
<para>use CLUSTALW output format instead of MFA</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option>
<option>--consistency</option> <varname>REPS</varname>
</term>
<listitem>
<para>use 0 <= <varname>REPS</varname> <= 5 (default: 0) passes of consistency transformation</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-ir</option>
<option>--iterative-refinement</option> <varname>REPS</varname>
</term>
<listitem>
<para>use 0 <= <varname>REPS</varname> <=1000 (default: 0) passes of iterative-refinement</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-pre</option>
<option>--pre-training</option> <varname>REPS</varname>
</term>
<listitem>
<para>use 0 <= <varname>REPS</varname> <= 20 (default: 0) rounds of pretraining</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-pairs</option>
</term>
<listitem>
<para>generate all-pairs pairwise alignments</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-viterbi</option>
</term>
<listitem>
<para>use Viterbi algorithm to generate all pairs (automatically enables <option>-pairs</option>)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-v</option>
<option>--verbose</option>
</term>
<listitem>
<para>Report progress while aligning (default: off)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-annot</option> <filename>FILENAME</filename> </term>
<listitem>
<para>write annotation for multiple alignment to <filename>FILENAME</filename></para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-t</option>
<option>--train</option> <filename>FILENAME</filename>
</term>
<listitem>
<para>compute EM transition probabilities, store in <filename>FILENAME</filename> (default: no training)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-e</option>
<option>--emissions</option>
</term>
<listitem>
<para>also reestimate emission probabilities (default: off)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option>
<option>--paramfile</option> <filename>FILENAME</filename>
</term>
<listitem>
<para>read parameters from <filename>FILENAME</filename> (default: )</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-a</option>
<option>--alignment-order</option>
</term>
<listitem>
<para>print sequences in alignment order rather than input order (default: off)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-g</option>
<option>--gap-factor</option>
<varname>GF</varname>
</term>
<listitem>
<para>use <varname>GF</varname> as the gap-factor parameter, set to 0 for best sensitivity, higher values for better specificity (default: 0.5)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-w</option>
<option>--edge-weight-threshold</option>
<varname>W</varname>
</term>
<listitem>
<para>stop the sequence annealing process when best edge has lower weight than <varname>W</varname>, set to 0 for best sensitivity, higher values for better specificity (default: 0)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-prog</option>
<option>--progressive</option>
</term>
<listitem>
<para>use progressive alignment instead of sequence annealing alignment (default: off)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-noreorder</option>
<option>--no-edge-reordering</option>
</term>
<listitem>
<para>disable reordering of edges during sequence annealing alignment (default: off)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-maxstep</option>
<option>--use-max-stepsize</option>
</term>
<listitem>
<para>use maximum improvement step size instead of tGf edge ranking (default: off)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-print</option>
<option>--print-posteriors</option>
</term>
<listitem>
<para>only print the posterior probability matrices (default: off)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-gui</option>
<varname>START</varname>
<varname>STEP</varname>
</term>
<listitem>
<para> print output for the AMAP Display Java based GUI (default: ) starting at weight <varname>START</varname> (default: infinity) with step size <varname>STEP</varname> (default: )</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>
EXAMPLES
</title>
<para>
To run AMAP with the default options change to the <filename>align</filename> directory and type:
</para>
<para>
<command>% amap <multi-fasta-file-name></command>
</para>
<para>
If no file name is provided the list of options are printed.
</para>
<para>
In order to use the AMAP Display run AMAP with the -gui option, and save the output to a file, then use the file as the input to AmapDisplay. For example, type:
</para>
<para>
<command>% align/amap -gui examples/BB12020.tfa > examples/BB12020.tfa.out</command>
</para>
<para>
<command>% java -jar display/AmapDisplay.jar examples/BB12020.tfa.out</command>
</para>
<para>
(on Debian systems, the <filename>examples</filename> directory is in <filename>/usr/share/doc/amap-align/examples</filename>
</para>
</refsect1>
<refsect1>
<title>
NOTE
</title>
<para>In older versions ( < 2.0-1) of the package for &debian; systems, the <command>amap</command> command was renamed <command>amap-align</command> because there was already another tool called <command>amap</command> (which performs some computer network diagnostics). A symbolic link <command>amap-align</command> is still provided for upgrade purposes but will be removed in Debian releases posterior to Etch (Debian 4.0).</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
The current version of AMAP uses the PROBCONS 1.09 code base for some of the input/output procedures, and for the calculation of posterior probabilities (see PROBCONS.README in <filename>/usr/share/doc/amap-align/</filename>). Future releases might implement the algorithm using a new independent code base.
</para>
<para>
On &debian; systems, <citerefentry><refentrytitle>probcons</refentrytitle><manvolnum>1</manvolnum></citerefentry> is available in the probcons package.</para>
</refsect1>
<refsect1>
<title>REFERENCES</title>
<para>
For more details on AMAP and AMA, see Schwartz, Ariel S., Myers, Eugene W., and Pachter, Lior. Alignment Metric Accuracy (Submitted for publication). For more details on sequence-annealing, see Schwartz, Ariel S. and Pachter, Lior. Multiple Alignment by Sequence Annealing (Submitted for publication).
</para>
<para>
PROBCONS was published in Do, C.B., Mahabhashyam, M.S.P., Brudno, M., and Batzoglou, S. 2005. PROBCONS: Probabilistic Consistency-based Multiple Sequence Alignment. Genome Research 15: 330-340.
</para>
</refsect1>
</refentry>
|
