File: probcons.1.xml

package info (click to toggle)
probcons 1.12-15
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 664 kB
  • sloc: cpp: 7,263; xml: 567; makefile: 114; sh: 21
file content (233 lines) | stat: -rw-r--r-- 8,665 bytes parent folder | download | duplicates (7)
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
<?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.2//EN"
"/usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd" [

  <!ENTITY dhfirstname "Charles">
  <!ENTITY dhsurname   "Plessy">
  <!ENTITY dhusername  "&dhfirstname; &dhsurname;">
  <!ENTITY dhdate      "2007-04-04">
  <!ENTITY dhsection   "1">
  <!ENTITY dhemail     "charles-debian-nospam@plessy.org">
  <!ENTITY dhucpackage "PROBCONS">
  <!ENTITY dhpackage   "probcons">
  <!ENTITY dhrelease   "1.12">
  <!ENTITY dhproduct   "&dhpackage;">
  <!ENTITY dhtitle     "Probcons Manual">
  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <title>&dhtitle;</title>
    <productname>&dhpackage;</productname>
    <releaseinfo role="version">&dhrelease;</releaseinfo>
    <date>&dhdate;</date>
    <authorgroup>
      <author>
        <firstname>Chuong</firstname>
        <surname>Do</surname>
        <contrib>Wrote probcons in collaboration with Michael Brudno in the research group of Serafim Batzoglou, Department of Computer Science, Stanford University.</contrib>
        <address>
          <email>chuongdo@cs.stanford.edu</email>
        </address>
      </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>
    <!--<copyright>
            <year>2004</year>
            <year>2005</year>
            <year>2006</year>
            <year>2007</year>
            <holder>Chuong Do</holder>
    </copyright>
    <copyright>
            <year>2006</year>
            <year>2007</year>
            <holder>&dhusername;</holder>
    </copyright>--><!-- Public domain: no copyright -->
    <legalnotice>
      <para>This program and its manpage are in the public domain.</para>
    </legalnotice>
  </refentryinfo>
  
  <refmeta>
    <refentrytitle>&dhucpackage;</refentrytitle>
    <manvolnum>&dhsection;</manvolnum>
  </refmeta>
  
  <refnamediv>
    <refname>&dhpackage;</refname>
  
    <refpurpose>align multiple protein sequences and print to standard output</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</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><command>&dhpackage;</command> is a tool for generating multiple alignments of protein sequences. Using a combination of probabilistic modeling and consistency-based alignment techniques, PROBCONS has achieved the highest accuracies of all alignment methods to date. On the BAliBASE benchmark alignment database, alignments produced by PROBCONS show statistically significant improvement over current programs, containing an average of 7% more correctly aligned columns than those of T-Coffee, 11% more correctly aligned columns than those of CLUSTAL W, and 14% more correctly aligned columns than those of DIALIGN.</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>&gt;</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 &lt;= <varname>REPS</varname> &lt;= 5 (default: 2) passes of consistency transformation</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-ir</option>
          <option>--iterative-refinement</option> <varname>REPS</varname>
        </term>
        <listitem>
          <para>use 0 &lt;= <varname>REPS</varname> &lt;=1000 (default: 100) passes of iterative-refinement</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-pre</option>
          <option>--pre-training</option> <varname>REPS</varname>
        </term>
        <listitem>
          <para>use 0 &lt;= <varname>REPS</varname> &lt;= 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>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>
    <itemizedlist>
      <listitem><para>You can find more information in the manual of ProbCons, which is located in  <filename>/usr/share/doc/probcons/manual.pdf</filename> in Debian systems.</para></listitem>

      <listitem><para>An experimental version of ProbCons compiled with parameters estimated via unsupervised training on BRAliBASE, <citerefentry><refentrytitle>probcons-RNA</refentrytitle><manvolnum>1</manvolnum></citerefentry>, is also distributed in the ProbCons Debian package.</para></listitem>

      <listitem>
        <para>
          <citerefentry>
            <refentrytitle>pc-makegnufile</refentrytitle>
            <manvolnum>1</manvolnum>
          </citerefentry>,
          <citerefentry>
            <refentrytitle>pc-compare</refentrytitle>
            <manvolnum>1</manvolnum>
          </citerefentry>,
          <citerefentry>
            <refentrytitle>pc-project</refentrytitle>
            <manvolnum>1</manvolnum>
          </citerefentry>,
          which are distributed separately in the probcons-extra package.</para></listitem>
    </itemizedlist>
  </refsect1>

  <refsect1>
    <title>REFERENCE</title>
    <para>Please cite  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>