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

   1 .TH "hmmcalibrate" 1 @RELEASEDATE@ "HMMER @RELEASE@" "HMMER Manual"
   2
   3 .SH NAME
   4 .TP
   5 hmmcalibrate - calibrate HMM search statistics
   6
   7 .SH SYNOPSIS
   8 .B hmmcalibrate
   9 .I [options]
  10 .I hmmfile
  11
  12 .SH DESCRIPTION
  13
  14 .B hmmcalibrate
  15 reads an HMM file from
  16 .I hmmfile,
  17 scores a large number of synthesized random sequences with it, fits an
  18 extreme value distribution (EVD) to the histogram of those scores, and
  19 re-saves
  20 .I hmmfile
  21 now including the EVD parameters.
  22
  23 .PP
  24 .B hmmcalibrate
  25 may take several minutes (or longer) to run.
  26 While it is running, a temporary file called
  27 .I hmmfile.xxx
  28 is generated in your working directory.
  29 If you abort
  30 .B hmmcalibrate
  31 prematurely (ctrl-C, for instance), your original
  32 .I hmmfile
  33 will be untouched, and you should delete the
  34 .I hmmfile.xxx
  35 temporary file.
  36
  37 .SH OPTIONS
  38
  39 .TP
  40 .B -h
  41 Print brief help; includes version number and summary of
  42 all options, including expert options.
  43
  44 .SH EXPERT OPTIONS
  45
  46 .TP
  47 .BI --cpu " <n>"
  48 Sets the maximum number of CPUs that the program
  49 will run on. The default is to use all CPUs
  50 in the machine. Overrides the HMMER_NCPU
  51 environment variable. Only affects threaded
  52 versions of HMMER (the default on most systems).
  53
  54 .TP
  55 .BI --fixed " <n>"
  56 Fix the length of the random sequences to
  57 .I <n>,
  58 where
  59 .I <n>
  60 is a positive (and reasonably sized) integer.
  61 The default is instead to generate sequences with
  62 a variety of different lengths, controlled by a Gaussian
  63 (normal) distribution.
  64
  65 .TP
  66 .BI --histfile " <f>"
  67 Save a histogram of the scores and the fitted theoretical curve
  68 to file
  69 .I <f>.
  70
  71 .TP
  72 .BI --mean " <x>"
  73 Set the mean length of the synthetic sequences to
  74 .I <x>,
  75 where
  76 .I <x>
  77 is a positive real number. The default is 350.
  78
  79 .TP
  80 .BI --num " <n>"
  81 Set the number of synthetic sequences to
  82 .I <n>,
  83 where
  84 .I <n>
  85 is a positive integer. If
  86 .I <n> is less than about 1000, the fit to the EVD may fail.
  87 Higher numbers of
  88 .I <n>
  89 will give better determined EVD parameters. The default
  90 is 5000; it was empirically chosen as
  91 a tradeoff between accuracy and computation time.
  92
  93 .TP
  94 .B --pvm
  95 Run on a Parallel Virtual Machine (PVM). The PVM must
  96 already be running. The client program
  97 .B hmmcalibrate-pvm
  98 must be installed on all the PVM nodes.
  99 Optional PVM support must have been compiled into
 100 HMMER.
 101
 102 .TP
 103 .BI --sd " <x>"
 104 Set the standard deviation of the synthetic sequence
 105 length distribution to
 106 .I <x>,
 107 where
 108 .I <x>
 109 is a positive real number. The default is 350. Note that the
 110 Gaussian is left-truncated so that no sequences have lengths
 111 <= 0.
 112
 113 .TP
 114 .BI --seed " <n>"
 115 Set the random seed to
 116 .I <n>,
 117 where
 118 .I <n>
 119 is a positive integer. The default is to use
 120 .B time()
 121 to generate a different seed for each run, which
 122 means that two different runs of
 123 .B hmmcalibrate
 124 on the same HMM will give slightly different
 125 results.  You can use
 126 this option to generate reproducible results for
 127 different
 128 .B hmmcalibrate
 129 runs on the same HMM.
 130
 131 .SH SEE ALSO
 132
 133 .PP
 134 Master man page, with full list of and guide to the individual man
 135 pages: see
 136 .B hmmer(1).
 137 .PP
 138 A User guide and tutorial came with the distribution:
 139 .B Userguide.ps
 140 [Postscript] and/or
 141 .B Userguide.pdf
 142 [PDF].
 143 .PP
 144 Finally, all documentation is also available online via WWW:
 145 .B http://hmmer.wustl.edu/
 146
 147 .SH AUTHOR
 148
 149 This software and documentation is:
 150 .nf
 151 @COPYRIGHT@
 152 HMMER - Biological sequence analysis with profile HMMs
 153 Copyright (C) 1992-1999 Washington University School of Medicine
 154 All Rights Reserved
 155
 156     This source code is distributed under the terms of the
 157     GNU General Public License. See the files COPYING and LICENSE
 158     for details.
 159 .fi
 160 See the file COPYING in your distribution for complete details.
 161
 162 .nf
 163 Sean Eddy
 164 HHMI/Dept. of Genetics
 165 Washington Univ. School of Medicine
 166 4566 Scott Ave.
 167 St Louis, MO 63110 USA
 168 Phone: 1-314-362-7666
 169 FAX  : 1-314-362-7855
 170 Email: eddy@genetics.wustl.edu
 171 .fi
 172