forester/archive/RIO/others/hmmer/documentation/man/hmmalign.man

   1 .TH "hmmalign" 1 @RELEASEDATE@ "HMMER @RELEASE@" "HMMER Manual"
   2
   3 .SH NAME
   4 .TP
   5 hmmalign - align sequences to an HMM profile
   6
   7 .SH SYNOPSIS
   8 .B hmmalign
   9 .I [options]
  10 .I hmmfile
  11 .I seqfile
  12
  13 .SH DESCRIPTION
  14
  15 .B hmmalign
  16 reads an HMM file from
  17 .I hmmfile
  18 and a set of sequences from
  19 .I seqfile,
  20 aligns the sequences to the profile HMM,
  21 and outputs a multiple sequence alignment.
  22
  23 .PP
  24 .I seqfile
  25 may be in any unaligned or aligned file format
  26 accepted by HMMER. If it is in a multiple alignment format
  27 (e.g. Stockholm, MSF, SELEX, ClustalW), the existing alignment
  28 is ignored (i.e., the sequences are read as if they were
  29 unaligned - hmmalign will align them the way it wants).
  30
  31 .SH OPTIONS
  32
  33 .TP
  34 .B -h
  35 Print brief help; includes version number and summary of
  36 all options, including expert options.
  37
  38 .TP
  39 .B -m
  40 Include in the alignment only those symbols aligned to match states.
  41 Do not show symbols assigned to insert states.
  42
  43 .TP
  44 .BI -o " <f>"
  45 Save alignment to file
  46 .I <f>
  47 instead of to standard output.
  48
  49 .TP
  50 .B -q
  51 quiet; suppress all output except the alignment itself.
  52 Useful for piping or redirecting the output.
  53
  54 .SH EXPERT OPTIONS
  55
  56 .TP
  57 .BI --informat " <s>"
  58 Assert that the input
  59 .I seqfile
  60 is in format
  61 .I <s>;
  62 do not run Babelfish format autodection. This increases
  63 the reliability of the program somewhat, because
  64 the Babelfish can make mistakes; particularly
  65 recommended for unattended, high-throughput runs
  66 of HMMER. Valid format strings include FASTA,
  67 GENBANK, EMBL, GCG, PIR, STOCKHOLM, SELEX, MSF,
  68 CLUSTAL, and PHYLIP. See the User's Guide for a complete
  69 list.
  70
  71 .TP
  72 .BI --mapali " <f>"
  73 Reads an alignment from file
  74 .I <f>
  75 and aligns it as a single object to the HMM; e.g. the alignment in
  76 .I <f>
  77 is held fixed.
  78 This allows you to align sequences to a model with
  79 .B hmmalign
  80 and view them in the context of an existing trusted
  81 multiple alignment.
  82 The alignment to the alignment is defined by a "map" kept
  83 in the HMM, and so is fast and guaranteed to be consistent
  84 with the way the HMM was constructed from the alignment.
  85 The alignment in the file
  86 .I <f>
  87 must be exactly the alignment that the HMM was built from.
  88 Compare the
  89 .B --withali
  90 option.
  91
  92 .TP
  93 .BI --withali " <f>"
  94 Reads an alignment from file
  95 .I <f>
  96 and aligns it as a single object to the HMM; e.g. the alignment in
  97 .I <f>
  98 is held fixed.
  99 This allows you to align sequences to a model with
 100 .B hmmalign
 101 and view them in the context of an existing trusted
 102 multiple alignment. The alignment to the alignment is
 103 done with a heuristic (nonoptimal) dynamic programming procedure,
 104 which may be somewhat slow and is not guaranteed to
 105 be completely consistent with the way the HMM was
 106 constructed (though it should be quite close).
 107 However, any alignment can be used, not just the alignment that
 108 the HMM was built from. Compare the
 109 .B --mapali
 110 option.
 111
 112 .SH SEE ALSO
 113
 114 .PP
 115 Master man page, with full list of and guide to the individual man
 116 pages: see
 117 .B hmmer(1).
 118 .PP
 119 A User guide and tutorial came with the distribution:
 120 .B Userguide.ps
 121 [Postscript] and/or
 122 .B Userguide.pdf
 123 [PDF].
 124 .PP
 125 Finally, all documentation is also available online via WWW:
 126 .B http://hmmer.wustl.edu/
 127
 128 .SH AUTHOR
 129
 130 This software and documentation is:
 131 .nf
 132 @COPYRIGHT@
 133 HMMER - Biological sequence analysis with profile HMMs
 134 Copyright (C) 1992-1999 Washington University School of Medicine
 135 All Rights Reserved
 136
 137     This source code is distributed under the terms of the
 138     GNU General Public License. See the files COPYING and LICENSE
 139     for details.
 140 .fi
 141 See the file COPYING in your distribution for complete details.
 142
 143 .nf
 144 Sean Eddy
 145 HHMI/Dept. of Genetics
 146 Washington Univ. School of Medicine
 147 4566 Scott Ave.
 148 St Louis, MO 63110 USA
 149 Phone: 1-314-362-7666
 150 FAX  : 1-314-362-7855
 151 Email: eddy@genetics.wustl.edu
 152 .fi
 153
 154