← Back to branch summary

~ubuntu-branches/debian/experimental/ncbi-tools6/experimental

« back to all changes in this revision

Viewing changes to debian/man/blastclust.1

  • Committer: Bazaar Package Importer
  • Author(s): Aaron M. Ucko
  • Date: 2002-04-04 22:13:09 UTC
  • Revision ID: james.westby@ubuntu.com-20020404221309-ozxf0jg82nb8ud7h
Tags: 6.1.20011220a-2
Whoops, ncbi-data should replace pre-split versions of ncbi-tools6.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/man/blastclust.1
 
1
.TH BLASTCLUST 1 2001-12-28 NCBI "NCBI Tools User's Manual"
 
2
.SH NAME
 
3
blastclust \- BLAST score-based single-linkage clustering
 
4
.SH SYNOPSIS
 
5
.B blastclust
 
6
[\|\fB-\fP\|]
 
7
[\|\fB-C\fP\|]
 
8
[\|\fB-L\fP\ \fIX\fP\|]
 
9
[\|\fB-S\fP\ \fIX\fP\|]
 
10
[\|\fB-a\fP\ \fIN\fP\|]
 
11
[\|\fB-b\ F\fP\|]
 
12
[\|\fB-c\fP\ \fIfilename\fP\|]
 
13
[\|\fB-d\fP\ \fIfilename\fP\|]
 
14
[\|\fB-e\ F\fP\|]
 
15
[\|\fB-i\fP\ \fIfilename\fP\|]
 
16
[\|\fB-l\fP\ \fIfilename\fP\|]
 
17
[\|\fB-o\fP\ \fIfilename\fP\|]
 
18
[\|\fB-p\ F\fP\|]
 
19
[\|\fB-r\fP\ \fIfilename\fP\|]
 
20
[\|\fB-s\fP\ \fIfilename\fP\|]
 
21
[\|\fB-v\fP\ [\|\fIfilename\fP\|]\|]
 
22
.SH DESCRIPTION
 
23
This manual page documents briefly the \fBblastclust\fP command.
 
24
This manual page was written for the Debian GNU/Linux distribution
 
25
because the original program does not have a manual page.
 
26
.PP
 
27
\fBblastclust\fP automatically and systematically clusters protein or
 
28
DNA sequences based on pairwise matches found using the BLAST
 
29
algorithm in case of proteins or Mega BLAST algorithm for DNA. In the
 
30
latter case a single Mega BLAST search is performed for all the
 
31
sequences combined against a database created from the same
 
32
sequences. \fBblastclust\fP finds pairs of sequences that have
 
33
statistically significant matches and clusters them using
 
34
single-linkage clustering.
 
35
.SH OPTIONS
 
36
A summary of options is included below.
 
37
.TP
 
38
\fB-\fP
 
39
Print usage message
 
40
.TP
 
41
\fB-C\fP
 
42
Complete unfinished clustering
 
43
.TP
 
44
\fB-L\fP\ \fIX\fP
 
45
Length coverage threshold (default = 0.9)
 
46
.TP
 
47
\fB-S\fP\ \fIX\fP
 
48
Score coverage threshold (bit score / length if < 3.0, percentage of
 
49
identities otherwise; default = 1.75)
 
50
.TP
 
51
\fB-a\fP\ \fIN\fP
 
52
Number of CPU's to use (default = 1)
 
53
.TP
 
54
\fB-b\ F\fP
 
55
Do not require coverage on both neighbours
 
56
.TP
 
57
\fB-c\fP\ \fIfilename\fP
 
58
Read advanced options from configuration file \fIfilename\fP
 
59
.TP
 
60
\fB-d\fP\ \fIfilename\fP
 
61
Input as a database
 
62
.TP
 
63
\fB-e\ F\fP
 
64
Disable id parsing in database formatting
 
65
.TP
 
66
\fB-i\fP\ \fIfilename\fP
 
67
FASTA input file (program will format the database and remove files in
 
68
the end; default = stdin)
 
69
.TP
 
70
\fB-l\fP\ \fIfilename\fP
 
71
Restrict reclustering to id list in \fIfilename\fP
 
72
.TP
 
73
\fB-o\fP\ \fIfilename\fP
 
74
Output file for list of clusters (default = stdout)
 
75
.TP
 
76
\fB-p\ F\fP
 
77
Input is nucleotides, not proteins.
 
78
.TP
 
79
\fB-r\fP\ \fIfilename\fP
 
80
Restore neighbors for reclustering from \fIfilename\fP
 
81
.TP
 
82
\fB-s\fP\ \fIfilename\fP
 
83
Save all neighbours to \fIfilename\fP
 
84
.TP
 
85
\fB-v\fP\ [\|\fIfilename\fP\|]
 
86
Print verbose progress messages (to \fIfilename\fP)
 
87
.SH AUTHOR
 
88
This manual page was written by Aaron M. Ucko <ucko@debian.org>,
 
89
for the Debian GNU/Linux system (but may be used by others).
 
90
.SH SEE ALSO
 
91
.ad l
 
92
.BR blast (1),
 
93
.BR formatdb (1),
 
94
/usr/share/doc/blast2/README.bcl.gz,
 
95
<http://www.ncbi.nlm.nih.gov/BLAST/>