~ubuntu-branches/ubuntu/feisty/amap-align/feisty

« back to all changes in this revision

Viewing changes to debian/amap-align.1.xml

  • Committer: Bazaar Package Importer
  • Author(s): Charles Plessy
  • Date: 2006-07-09 12:53:25 UTC
  • Revision ID: james.westby@ubuntu.com-20060709125325-qybez3p61uom6hdb
Tags: 2.0-1
Initial release Closes: #366321

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version='1.0' encoding='ISO-8859-1'?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 
3
"/usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [
 
4
 
 
5
  <!ENTITY dhfirstname "<firstname>Plessy</firstname>">
 
6
  <!ENTITY dhsurname   "<surname>Plessy</surname>">
 
7
  <!ENTITY dhdate      "<date>mai 3, 2006</date>">
 
8
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
 
9
  <!ENTITY dhemail     "<email>charles-debian-nospam@plessy.org</email>">
 
10
  <!ENTITY dhusername  "Charles Plessy">
 
11
  <!ENTITY dhucpackage "<refentrytitle>AMAP</refentrytitle>">
 
12
  <!ENTITY dhpackage   "amap-align">
 
13
  <!ENTITY debian      "<productname>Debian</productname>">
 
14
  <!ENTITY gnu         "<acronym>GNU</acronym>">
 
15
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
 
16
]>
 
17
 
 
18
<refentry>
 
19
  <refentryinfo>
 
20
    <address>
 
21
      &dhemail;
 
22
    </address>
 
23
<!--     <author>
 
24
      &dhfirstname;
 
25
      &dhsurname;
 
26
    </author>  -->
 
27
    <copyright>
 
28
      <year>2006</year>
 
29
      <holder>&dhusername;</holder>
 
30
    </copyright>
 
31
    &dhdate;
 
32
  </refentryinfo>
 
33
  <refmeta>
 
34
    &dhucpackage;
 
35
 
 
36
    &dhsection;
 
37
  </refmeta>
 
38
  <refnamediv>
 
39
    <refname>&dhpackage;</refname>
 
40
 
 
41
    <refpurpose>Protein multiple alignment by sequence annealing</refpurpose>
 
42
  </refnamediv>
 
43
  <refsynopsisdiv>
 
44
    <cmdsynopsis>
 
45
      <command>&dhpackage;</command>
 
46
 
 
47
      <arg choice="opt"><option><replaceable>OPTION</replaceable></option></arg>
 
48
 
 
49
      <arg><replaceable>MFAFILE</replaceable></arg>
 
50
      <arg choice="opt"><replaceable>MFAFILE</replaceable></arg>
 
51
    </cmdsynopsis>
 
52
  </refsynopsisdiv>
 
53
  <refsect1>
 
54
    <title>DESCRIPTION</title>
 
55
 
 
56
    <para>On &debian; systems, the <command>amap</command> command has been renamed <command>amap-align</command> because there was already another tool called <command>amap</command> (which performs some computer network diagnostics)</para>
 
57
 
 
58
    <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>
 
59
 
 
60
    <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>
 
61
 
 
62
    <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>&gt;</quote>) symbol in the first column.</para>
 
63
 
 
64
  </refsect1>
 
65
  <refsect1>
 
66
    <title>OPTIONS</title>
 
67
 
 
68
    <variablelist>
 
69
      <varlistentry>
 
70
        <term><option>-clustalw</option>
 
71
        </term>
 
72
        <listitem>
 
73
          <para>use CLUSTALW output format instead of MFA</para>
 
74
        </listitem>
 
75
      </varlistentry>
 
76
 
 
77
      <varlistentry>
 
78
        <term><option>-c</option>
 
79
          <option>--consistency</option> <varname>REPS</varname>
 
80
        </term>
 
81
        <listitem>
 
82
          <para>use 0 &lt;= <varname>REPS</varname> &lt;= 5 (default: 0) passes of consistency transformation</para>
 
83
        </listitem>
 
84
      </varlistentry>
 
85
 
 
86
      <varlistentry>
 
87
        <term><option>-ir</option>
 
88
          <option>--iterative-refinement</option> <varname>REPS</varname>
 
89
        </term>
 
90
        <listitem>
 
91
          <para>use 0 &lt;= <varname>REPS</varname> &lt;=1000 (default: 0) passes of iterative-refinement</para>
 
92
        </listitem>
 
93
      </varlistentry>
 
94
 
 
95
      <varlistentry>
 
96
        <term><option>-pre</option>
 
97
          <option>--pre-training</option> <varname>REPS</varname>
 
98
        </term>
 
99
        <listitem>
 
100
          <para>use 0 &lt;= <varname>REPS</varname> &lt;= 20 (default: 0) rounds of pretraining</para>
 
101
        </listitem>
 
102
      </varlistentry>
 
103
 
 
104
      <varlistentry>
 
105
        <term>
 
106
          <option>-pairs</option>
 
107
        </term>
 
108
        <listitem>
 
109
          <para>generate all-pairs pairwise alignments</para>
 
110
        </listitem>
 
111
      </varlistentry>
 
112
 
 
113
      <varlistentry>
 
114
        <term>
 
115
          <option>-viterbi</option>
 
116
        </term>
 
117
        <listitem>
 
118
          <para>use Viterbi algorithm to generate all pairs (automatically enables <option>-pairs</option>)</para>
 
119
        </listitem>
 
120
      </varlistentry>
 
121
 
 
122
      <varlistentry>
 
123
        <term>
 
124
          <option>-v</option>
 
125
          <option>--verbose</option>
 
126
        </term>
 
127
        <listitem>
 
128
          <para>Report progress while aligning (default: off)</para>
 
129
        </listitem>
 
130
      </varlistentry>
 
131
 
 
132
      <varlistentry>
 
133
        <term><option>-annot</option> <filename>FILENAME</filename>        </term>
 
134
        <listitem>
 
135
          <para>write annotation for multiple alignment to <filename>FILENAME</filename></para>
 
136
        </listitem>
 
137
      </varlistentry>
 
138
 
 
139
      <varlistentry>
 
140
        <term><option>-t</option>
 
141
          <option>--train</option> <filename>FILENAME</filename>
 
142
        </term>
 
143
        <listitem>
 
144
          <para>compute EM transition probabilities, store in <filename>FILENAME</filename> (default: no training)</para>
 
145
        </listitem>
 
146
      </varlistentry>
 
147
 
 
148
      <varlistentry>
 
149
        <term><option>-e</option>
 
150
          <option>--emissions</option>
 
151
        </term>
 
152
        <listitem>
 
153
          <para>also reestimate emission probabilities (default: off)</para>
 
154
        </listitem>
 
155
      </varlistentry>
 
156
 
 
157
      <varlistentry>
 
158
        <term><option>-p</option>
 
159
          <option>--paramfile</option> <filename>FILENAME</filename>
 
160
        </term>
 
161
        <listitem>
 
162
          <para>read parameters from <filename>FILENAME</filename> (default: )</para>
 
163
        </listitem>
 
164
      </varlistentry>
 
165
 
 
166
      <varlistentry>
 
167
        <term><option>-a</option>
 
168
          <option>--alignment-order</option>
 
169
        </term>
 
170
        <listitem>
 
171
          <para>print sequences in alignment order rather than input order (default: off)</para>
 
172
        </listitem>
 
173
      </varlistentry>
 
174
      
 
175
      <varlistentry>
 
176
        <term><option>-g</option>
 
177
          <option>--gap-factor</option>
 
178
          <varname>GF</varname>
 
179
        </term>
 
180
        <listitem>
 
181
          <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>
 
182
        </listitem>
 
183
      </varlistentry>
 
184
      
 
185
      <varlistentry>
 
186
        <term><option>-w</option>
 
187
          <option>--edge-weight-threshold</option>
 
188
          <varname>W</varname>
 
189
        </term>
 
190
        <listitem>
 
191
          <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>
 
192
        </listitem>
 
193
      </varlistentry>
 
194
      
 
195
      <varlistentry>
 
196
        <term><option>-prog</option>
 
197
          <option>--progressive</option>
 
198
        </term>
 
199
        <listitem>
 
200
          <para>use progressive alignment instead of sequence annealing alignment (default: off)</para>
 
201
        </listitem>
 
202
      </varlistentry>
 
203
      
 
204
      <varlistentry>
 
205
        <term><option>-noreorder</option>
 
206
          <option>--no-edge-reordering</option>
 
207
        </term>
 
208
        <listitem>
 
209
          <para>disable reordering of edges during sequence annealing alignment (default: off)</para>
 
210
        </listitem>
 
211
      </varlistentry>
 
212
      
 
213
      <varlistentry>
 
214
        <term><option>-maxstep</option>
 
215
          <option>--use-max-stepsize</option>
 
216
        </term>
 
217
        <listitem>
 
218
          <para>use maximum improvement step size instead of tGf edge ranking (default: off)</para>
 
219
        </listitem>
 
220
      </varlistentry>
 
221
      
 
222
      <varlistentry>
 
223
        <term><option>-print</option>
 
224
          <option>--print-posteriors</option>
 
225
        </term>
 
226
        <listitem>
 
227
          <para>only print the posterior probability matrices (default: off)</para>
 
228
        </listitem>
 
229
      </varlistentry>
 
230
    </variablelist>
 
231
  </refsect1>
 
232
  
 
233
  <refsect1>
 
234
    <title>SEE ALSO</title>
 
235
    <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. On &debian; systems, PROBCONS is available in the probcons package.</para>
 
236
  </refsect1>
 
237
 
 
238
  <refsect1>
 
239
    <title>REFERENCES</title>
 
240
    <para>
 
241
      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).
 
242
    </para>
 
243
 
 
244
    <para>
 
245
      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.
 
246
    </para>
 
247
  </refsect1>
 
248
 
 
249
  <refsect1>
 
250
    <title>AUTHORS</title>
 
251
    <itemizedlist>
 
252
      <listitem><para>PROBCONS was written by Chuong Do.</para></listitem>
 
253
      <listitem><para>AMAP algorithm implemented by Ariel Schwartz (<email>sariel@cs.berkeley.edu</email>).</para></listitem>
 
254
      <listitem><para>This manual page was written by &dhusername; &dhemail; for the &debian; system (but may be used by others).</para></listitem>
 
255
    </itemizedlist>
 
256
  </refsect1>
 
257
  
 
258
  <refsect1>
 
259
    <title>LICENCE</title>
 
260
    <para>
 
261
      AMAP comes with ABSOLUTELY NO WARRANTY. This is free software, and you are welcome to redistribute it under certain conditions. See the files README and README.PROBCONS for details.
 
262
    </para>
 
263
    <para>This manpage is hereby placed in the public domain.</para>
 
264
  </refsect1>
 
265
    
 
266
  
 
267
</refentry>