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 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
|
<?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" [
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Charles</firstname>">
<!ENTITY dhsurname "<surname>Plessy</surname>">
<!ENTITY dhdate "<date>avril 9, 2006</date>">
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>plessy@debian.org</email>">
<!ENTITY dhusername "Charles Plessy">
<!ENTITY dhucpackage "<refentrytitle>DIALIGN</refentrytitle>">
<!ENTITY dhpackage "dialign2-2">
<!ENTITY dhrelease "2.2.1">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
<!ENTITY dhtitle "User Manual">
]>
<refentry>
<refentryinfo>
<title>&dhtitle;</title>
<productname>&dhpackage;</productname>
<releaseinfo role="version">&dhrelease;</releaseinfo>
<authorgroup>
<author>
<firstname>Burkhard</firstname>
<surname>Morgenstern</surname>
<contrib>Author of DIALIGN</contrib>
<address>
<email>bmorgen@gwdg.de</email>
</address>
</author>
<author>
<firstname>Said</firstname>
<surname>Abdeddaim</surname>
<contrib>Author of DIALIGN</contrib>
</author>
<author>
&dhfirstname;
&dhsurname;
<contrib>Wrote this manpage</contrib>
<address>&dhemail;</address>
</author>
</authorgroup>
<legalnotice>
<para>
DIALIGN was written by Burkhard Morgenstern and Said Abdeddaim at University of Bielefeld (FSPM and International Graduate School in Bioinformatics and Genome Research), GSF (ISG, IBB, MIPS/IBI), North Carolina State University, Universite de Rouen, MPI fuer Biochemie (Martinsried), University of Goettingen, Institute of Microbiology and Genetics.
</para>
<para>
This manual page was adapted from the DIALIGN manual by &dhusername; &dhemail; for the Debian system (but may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the &gnu; Lesser General Public License, Version 2.1 any later version published by the Free Software Foundation.
</para>
<para>
On Debian systems, the complete text of the GNU Lesser General Public License can be found in /usr/share/common-licenses/LGPL.
</para>
</legalnotice>
<copyright>
<year>1999</year>
<holder>Burkhard Morgenstern (for DIALIGN)</holder>
</copyright>
<copyright>
<year>2006</year>
<year>2007</year>
<year>2008</year>
<holder>&dhusername; (for this manpage)</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>Multiple alignment program using the segment-to-segment approach</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dialign2-2</command>
<arg choice="opt">options</arg>
<arg>seq_file</arg>
</cmdsynopsis>
<para><filename>seq_file</filename> is the name of the input sequence file; this must be a multiple FASTA file (all sequences in one file).</para>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhpackage;</command> is a program that constructs
alignments from gapfree pairs of similar segments of the
sequences. If (possibly) coding nucleic acid sequences are to be
aligned, DIALIGN optionally translates the compared `nucleic acid
segments' to `peptide segments' according to the genetic code --
without presupposing any of the three possible reading frames, so
all combinations of reading frames get checked for significant
similarity.</para>
<para>By default, DIALIGN creates a single file containing
<itemizedlist>
<listitem><para>An alignment of the input sequences in DIALIGN format.</para></listitem>
<listitem><para>The same alignment in FASTA format.</para></listitem>
<listitem><para>A sequence tree in PHYLIP format. This tree is constructed by applying
the UPGMA clustering method to the DIALIGN similarity scores. It roughly
reflects the different degrees of similarity among sequences. For
detailed phylogenetic analysis, we recommend the usual methods for
phylogenetic reconstruction.</para></listitem>
</itemizedlist>
</para>
<para>
The format of the output files is documented in <filename>/usr/share/doc/dialign/USER_GUIDE.gz</filename>. The FASTA, CLUSTALW and MSF output formats are optionally available (see OPTIONS).</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>-afc</option>
</term>
<listitem>
<para>Creates additional output file "*.afc" containing data of all fragments considered for alignment. WARNING: this file can be HUGE!</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-afc_v</option>
</term>
<listitem>
<para>Like "<option>-afc</option>" but verbose: fragments are explicitly printed. WARNING: this file can be EVEN BIGGER!</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-anc</option>
</term>
<listitem>
<para>Anchored alignment. Requires a file <filename>seq_file.anc</filename> containing anchor points.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-cs</option>
</term>
<listitem>
<para>If segments are translated, not only the `Watson strand' but also the `Crick strand' is looked at.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-cw</option>
</term>
<listitem>
<para>Additional output file in CLUSTAL W format.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-ds</option>
</term>
<listitem>
<para>`DNA alignment speed up'. Non-translated nucleic acid fragments are taken into account only if they start with at least two matches. Speeds up DNA alignment at the expense of sensitivity.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-fa</option>
</term>
<listitem>
<para>Additional output file in FASTA format.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-ff</option>
</term>
<listitem>
<para>Creates file <filename>*.frg</filename> containing information about all fragments that are part of the respective optimal pairwise alignmnets plus information about consistency in the multiple alignment.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-fn <filename>out_file</filename></option>
</term>
<listitem>
<para>Output files are named <filename>out_file.extension</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-fop</option>
</term>
<listitem>
<para>Creates file <filename>*.fop</filename> containing coordinates of all fragments that are part of the respective pairwise alignments.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-fsm</option>
</term>
<listitem>
<para>Creates file <filename>*.fsm</filename> containing coordinates of all fragments that are part of the final alignment</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-iw</option>
</term>
<listitem>
<para>Overlap weights switched off (by default, overlap weights are used if up to 35 sequences are aligned). This option speeds up the alignment but may lead to reduced alignment quality.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-lgs</option>
</term>
<listitem>
<para>`Long genomic sequences' - combines the following options: <option>-ma</option>, <option>-thr <parameter>2</parameter></option>, <option>-lmax <parameter>30</parameter></option>, <option>-smin <parameter>8</parameter></option>, <option>-nta</option>, <option>-ff</option>, <option>-fop</option>, <option>-ff</option>, <option>-cs</option>, <option>-ds</option>, <option>-pst</option>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-lgs_t</option>
</term>
<listitem>
<para>Like "<option>-lgs</option>" but with all segment pairs assessed at the peptide level (rather than 'mixed alignments' as with the "-lgs" option). Therefore faster than -lgs but not very sensitive for non-coding regions.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-lmax <parameter>x</parameter></option>
</term>
<listitem>
<para>Maximum fragment length = <parameter>x</parameter> (default: <parameter>x</parameter> = 40 or <parameter>x</parameter> = 120 for `translated' fragments). Shorter <parameter>x</parameter> speeds up the program but may affect alignment quality.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-lo</option>
</term>
<listitem>
<para>(Long Output) Additional file <filename>*.log</filename> with information abut fragments selected for pairwise alignment and about consistency in multi-alignment proceedure.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-ma</option>
</term>
<listitem>
<para>`mixed alignments' consisting of P-fragments and N-fragments if nucleic acid sequences are aligned.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-mask</option>
</term>
<listitem>
<para>Residues not belonging to selected fragments are replaced by `*' characters in output alignment (rather than being printed in lower-case characters)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-mat</option>
</term>
<listitem>
<para>Creates file <filename>*mat</filename> with substitution counts derived from the fragments that have been selected for alignment.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-mat_thr <parameter>t</parameter></option>
</term>
<listitem>
<para>Like "-mat" but only fragments with weight score >
<parameter>t</parameter> are considered.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-max_link</option>
</term>
<listitem>
<para>"Maximum linkage" clustering used to construct sequence tree (instead of UPGMA).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-min_link</option>
</term>
<listitem>
<para>"Minimum linkage" clustering used.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-mot</option>
</term>
<listitem>
<para>"Motif" option.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-msf</option>
</term>
<listitem>
<para>Separate output file in <acronym>MSF</acronym> format.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option>
</term>
<listitem>
<para>Input sequences are nucleic acid sequences. No translation
of fragments.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-nt</option>
</term>
<listitem>
<para>Input sequences are nucleic acid sequences and `nucleic acid segments' are translated to `peptide segments'.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-nta</option>
</term>
<listitem>
<para>`No textual alignment'. Textual alignment suppressed. This option makes sense if other output files are of intrest -- e.g. the fragment files created with <option>-ff</option>, <option>-fop</option>, <option>-fsm</option> or <option>-lo</option>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-o</option>
</term>
<listitem>
<para>Fast version, resulting alignments may be slightly different.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-ow</option>
</term>
<listitem>
<para>Overlap weights enforced (By default, overlap weights are used only if up to 35 sequences are aligned since calculating overlap weights is time consuming). Warning: overlap weights generally improve alignment quality but the running time increases in the order O(n^4) with the number of sequences. This is why, by default, overlap weights are used only for sequence sets with < 36 sequences.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-pst</option>
</term>
<listitem>
<para>"Print status". Creates and updates a file <filename>*.sta</filename> with information about the current status of the program run. This option is recommended if large data sets are aligned since it allows the user to estimate the remaining running time.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-smin <parameter>x</parameter></option>
</term>
<listitem>
<para>Minimum similarity value for first residue pair (or codon pair) in fragments. Speeds up protein alignment or alignment of translated DNA fragments at the expense of sensitivity.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-stars <parameter>x</parameter></option>
</term>
<listitem>
<para>Maximum number of `*' characters indicating degree of local similarity among sequences. By default, no stars are used but numbers between 0 and 9, instead.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-stdo</option>
</term>
<listitem>
<para>Results written to standard output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-ta</option>
</term>
<listitem>
<para>Standard textual alignment printed (overrides suppression of textual alignments in special options, e.g. -lgs).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-thr <parameter>x</parameter></option>
</term>
<listitem>
<para>Threshold T = x.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-xfr</option>
</term>
<listitem>
<para>"Exclude fragments". List of fragments can be specified that are NOT considered for pairwise alignment.</para>
</listitem>
</varlistentry>
</variablelist>
<para>
General remark: If contradictory options are used, subsequent
options override previous ones, e.g.: <code>dialign2-2 -nt -n
<filename>seq_file</filename></code> runs the program with the
"-n" option (no translation!), while <code>dialign2-2 -n -nt
<filename>seq_file</filename></code> runs it with the "-nt"
option (translation!).
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>The full documentation is in <filename>/usr/share/doc/dialign/</filename>.</para>
<para>The website of dialign: http://dialign.gobics.de/</para>
<para>DIALIGN2 has been re-implemented in <citerefentry><refentrytitle>dialign-tx</refentrytitle><manvolnum>1</manvolnum></citerefentry>. See http://dialign-tx.gobics.de/</para>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>You can create an environment variable `<envar>DIALIGN2_DIR</envar>' pointing to a directory where the substitution matrices are (see FILES). When installed from the Debian package, it is not necessary to set this environnement variable to run DIALIGN.</para>
</refsect1>
<refsect1>
<title>FILES</title>
<para>DIALIGN2 needs the files <filename>tp400_dna</filename>, <filename>tp400_prot</filename>, <filename>tp400_trans</filename> and <filename>BLOSUM</filename>. When DIALIGN is installed from the Debian package, they are stored in <filename>/usr/share/dialign/</filename>.</para>
<para>DIALIGN 2 uses the BLOSUM62 amino acid substitution matrix. In the current
version, it is NOT possible to replace BLOSUM62 by other similarity matrices.</para>
</refsect1>
<refsect1>
<title>REFERENCE</title>
<para>B. Morgenstern (1999).
DIALIGN 2: improvement of the segment-to-segment approach to
multiple sequence alignment.
Bioinformatics 15, 211 - 218.
Public research assisted by DIALIGN should cite this article.</para>
</refsect1>
</refentry>
|