initial commit
[jalview.git] / forester / archive / RIO / others / hmmer / documentation / man / hmmemit.man
1 .TH "hmmemit" 1 @RELEASEDATE@ "HMMER @RELEASE@" "HMMER Manual"
2
3 .SH NAME
4 .TP 
5 hmmemit - generate sequences from a profile HMM
6
7 .SH SYNOPSIS
8 .B hmmemit
9 .I [options]
10 .I hmmfile
11
12 .SH DESCRIPTION
13
14 .B hmmemit
15 reads an HMM file from
16 .I hmmfile
17 containing one or more HMMs,
18 and generates a number of sequences from each HMM;
19 or, if the
20 .B -c
21 option is selected, generate a single majority-rule consensus.
22 This can be useful for various applications in which one needs a simulation
23 of sequences consistent with a sequence family consensus. 
24
25 .pp
26 By default,
27 .B hmmemit
28 generates 10 sequences and outputs them in FASTA (unaligned) format.
29
30 .SH OPTIONS
31
32 .TP
33 .B -a
34 Write the generated sequences in an aligned format (SELEX) rather than
35 FASTA.
36
37 .TP
38 .B -c
39 Predict a single majority-rule consensus sequence instead of sampling
40 sequences from the HMM's probability distribution.  Highly conserved
41 residues (p >= 0.9 for DNA, p >= 0.5 for protein) are shown in upper
42 case; others are shown in lower case.  Some insert states may become
43 part of the majority rule consensus, because they are used in >= 50%
44 of generated sequences; when this happens, insert-generated residues
45 are simply shown as "x".
46
47 .TP
48 .B -h
49 Print brief help; includes version number and summary of
50 all options, including expert options.
51
52 .TP
53 .BI -n " <n>"
54 Generate
55 .I <n> 
56 sequences. Default is 10.
57
58 .TP
59 .BI -o " <f>"
60 Save the synthetic sequences to file
61 .I <f>
62 rather than writing them to stdout.
63
64 .TP
65 .B -q
66 Quiet; suppress all output except for the sequences themselves.
67 Useful for piping or directing the output.
68
69 .SH EXPERT OPTIONS
70
71 .TP
72 .BI --seed " <n>"
73 Set the random seed to
74 .I <n>,
75 where 
76 .I <n> 
77 is a positive integer. The default is to use 
78 .B time()
79 to generate a different seed for each run, which
80 means that two different runs of
81 .B hmmemit
82 on the same HMM will give slightly different
83 results.  You can use
84 this option to generate reproducible results.
85
86
87
88 .SH SEE ALSO
89
90 .PP
91 Master man page, with full list of and guide to the individual man
92 pages: see 
93 .B hmmer(1).
94 .PP
95 A User guide and tutorial came with the distribution:
96 .B Userguide.ps
97 [Postscript] and/or
98 .B Userguide.pdf
99 [PDF].
100 .PP
101 Finally, all documentation is also available online via WWW: 
102 .B http://hmmer.wustl.edu/
103
104 .SH AUTHOR
105
106 This software and documentation is: 
107 .nf
108 @COPYRIGHT@
109 HMMER - Biological sequence analysis with profile HMMs
110 Copyright (C) 1992-1999 Washington University School of Medicine
111 All Rights Reserved
112
113     This source code is distributed under the terms of the
114     GNU General Public License. See the files COPYING and LICENSE
115     for details.
116 .fi
117 See the file COPYING in your distribution for complete details.
118
119 .nf
120 Sean Eddy
121 HHMI/Dept. of Genetics
122 Washington Univ. School of Medicine
123 4566 Scott Ave.
124 St Louis, MO 63110 USA
125 Phone: 1-314-362-7666
126 FAX  : 1-314-362-7855
127 Email: eddy@genetics.wustl.edu
128 .fi
129
130