File: hmmpress.man.in

package info (click to toggle)
hmmer 3.3.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 35,432 kB
  • sloc: ansic: 129,659; perl: 10,152; sh: 3,331; makefile: 2,027; python: 1,007
file content (106 lines) | stat: -rw-r--r-- 1,801 bytes parent folder | download | duplicates (5)
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
.TH "hmmpress" 1 "@HMMER_DATE@" "HMMER @HMMER_VERSION@" "HMMER Manual"

.SH NAME
hmmpress \- prepare a profile database for hmmscan 

.SH SYNOPSIS

.B hmmpress
[\fIoptions\fR]
.I hmmfile


.SH DESCRIPTION

.PP
Constructs binary compressed datafiles for 
.BR hmmscan ,
starting from a profile database
.I hmmfile
in standard HMMER3 format.
The 
.B hmmpress
step is required for
.B hmmscan
to work.

.PP
Four files are created:
.IB hmmfile .h3m,
.IB hmmfile .h3i,
.IB hmmfile .h3f,
and
.IB hmmfile .h3p.
The 
.IB hmmfile .h3m
file contains the profile HMMs and their annotation in a binary
format.
The 
.IB hmmfile .h3i
file is an SSI index for the
.IB hmmfile .h3m
file.
The
.IB hmmfile .h3f
file contains precomputed data structures
for the fast heuristic filter (the MSV filter).
The
.IB hmmfile .h3p
file contains precomputed data structures
for the rest of each profile.

.PP
.I hmmfile
may not be '\-' (dash); running
.B hmmpress
on a standard input stream rather than a file
is not allowed.


.SH OPTIONS

.TP
.B \-h
Help; print a brief reminder of command line usage and all available
options.

.TP
.B \-f
Force; overwrites any previous hmmpress'ed datafiles. The default is
to bitch about any existing files and ask you to delete them first.




.SH SEE ALSO 

See 
.BR hmmer (1)
for a master man page with a list of all the individual man pages
for programs in the HMMER package.

.PP
For complete documentation, see the user guide that came with your
HMMER distribution (Userguide.pdf); or see the HMMER web page
(@HMMER_URL@).



.SH COPYRIGHT

.nf
@HMMER_COPYRIGHT@
@HMMER_LICENSE@
.fi

For additional information on copyright and licensing, see the file
called COPYRIGHT in your HMMER source distribution, or see the HMMER
web page 
(@HMMER_URL@).


.SH AUTHOR

.nf
http://eddylab.org
.fi