Next version of JABA
[jabaws.git] / binaries / src / fasta34 / fastf3.1
1 .TH FASTF/TFASTFv3 1 local
2 .SH NAME
3 fastf3, fastf3_t \- compare a mixed peptide sequence against a protein
4 database using a modified fasta algorithm.
5
6 tfastf3, tfastf3_t \- compare a mixed pepide sequence against a
7 translated DNA database.
8
9 .SH DESCRIPTION
10
11 .B fastf3
12 and
13 .B tfastf3
14 are designed to compare a sequence of mixed peptides to a protein
15 (fastf3) or translated DNA (tfastf3) database.  Unlike the traditional
16 .B fasta3
17 search, which uses a protein or DNA sequence,
18 .B fastf3
19 and
20 .B tfastf3
21 work with a query sequence of the form:
22 .in +5
23 .nf
24 >testf from mgstm1
25 MGCEN,
26 MIDYP,
27 MLLAY,
28 MLLGY
29 .fi
30 .in 0
31 This sequence indicates that a mixture of four peptides has been
32 found, with 'M' in the first position of each one (as from a CNBr
33 cleavage), in the second position 'G', 'I', or 'L' (twice), at the
34 third position 'C', 'D', or 'L' (twice), at the fourth position 'E',
35 'Y', 'A', or 'G', etc.  When this sequence is compared against mgstm1.aa 
36 (included with the distribution), the mixture is deconvolved to form:
37 .nf
38 .ft C
39 .in +5
40 testf    MILGY-----------MLLEY-----------MGDAP-----------
41          :::::           :::::           :::::           
42 GT8.7  MPMILGYWNVRGLTHPIRMLLEYTDSSYDEKRYTMGDAPDFDRSQWLNEK
43                10        20        30        40        50
44
45 testf  --------------------------------------------------
46                                                          
47 GT8.7  FKLGLDFPNLPYLIDGSHKITQSNAILRYLARKHHLDGETEEERIRADIV
48                60        70        80        90       100
49
50                       20                                 
51 testf  ------------MLCYN                                 
52                    :::::                                 
53 GT8.7  ENQVMDTRMQLIMLCYNPDFEKQKPEFLKTIPEKMKLYSEFLGKRPWFAG
54               110       120       130       140       150
55 .in 0
56 .ft P
57 .fi
58 .SH Options
59 .LP
60 .B fastf3
61 and
62 .B tfastf3
63 can accept a query sequence from the unix "stdin" data stream.  This makes it much
64 easier to use fasta3 and its relatives as part of a WWW page. To
65 indicate that stdin is to be used, use "-" or "@" as the query
66 sequence file name.
67 .TP
68 \-b #
69 number of best scores to show (must be < -E cutoff)
70 .TP
71 \-d #
72 number of best alignments to show ( must be < -E cutoff)
73 .TP
74 \-D
75 turn on debugging mode.  Enables checks on sequence alphabet that
76 cause problems with tfastx3, tfasty3, tfasta3.
77 .TP
78 \-E #
79 Expectation value limit for displaying scores and
80 alignments.  Expectation values for
81 .B fastf3
82 and
83 .B tfastf3
84 are not as accurate as those for the other 
85 .B fasta3
86 programs.
87 .TP
88 \-H
89 turn off histogram display
90 .TP
91 \-i
92 compare against only the reverse complement of the library sequence.
93 .TP
94 \-L
95 report long sequence description in alignments
96 .TP
97 \-m 0,1,2,3,4,5,6,10
98 alignment display options
99 .TP
100 \-n
101 force query to nucleotide sequence
102 .TP
103 \-N #
104 break long library sequences into blocks of # residues.  Useful for
105 bacterial genomes, which have only one sequence entry.  -N 2000 works
106 well for well for bacterial genomes.
107 .TP
108 \-O file
109 send output to file
110 .TP
111 \-q/-Q
112 quiet option; do not prompt for input
113 .TP 
114 \-R file
115 save all scores to statistics file
116 .TP
117 \-S #
118 offset substitution matrix values by  a constant #
119 .TP
120 \-s name
121 specify substitution matrix.  BLOSUM50 is used by default;
122 PAM250, PAM120, and BLOSUM62 can be specified by setting -s P120,
123 P250, or BL62.  With this version, many more scoring matrices are
124 available, including BLOSUM80 (BL80), and MDM_10, MDM_20, MDM_40 (M10,
125 M20, M40). Alternatively, BLASTP1.4 format scoring matrix files can be
126 specified.
127 .TP
128 \-T #
129 (threaded, parallel only) number of threads or workers to use (set by
130 default to 4 at compile time).
131 .TP
132 \-t #
133 Translation table - tfastf3 can use the BLAST tranlation tables.  See
134 \fChttp://www.ncbi.nlm.nih.gov/htbin-post/Taxonomy/wprintgc?mode=c/\fP.
135 .TP
136 \-w #
137 line width for similarity score, sequence alignment, output.
138 .TP
139 \-x "#,#"
140 offsets query, library sequence for numbering alignments
141 .TP
142 \-z #
143 Specify statistical calculation. Default is -z 1, which uses
144 regression against the length of the library sequence. -z 0 disables
145 statistics.  -z 2 uses the ln() length correction. -z 3 uses Altschul
146 and Gish's statistical estimates for specific protein BLOSUM scoring
147 matrices and gap penalties. -z 4: an alternate regression method.
148 .TP
149 \-Z db_size
150 Set the apparent database size used for expectation value calculations.
151 .TP
152 \-1
153 Sort by "init1" score.
154 .TP
155 \-3
156 (TFASTF3 only) use only forward frame translations
157 .SH Environment variables:
158 .TP
159 FASTLIBS
160 location of library choice file (-l FASTLIBS)
161 .TP
162 SMATRIX
163 default scoring matrix (-s SMATRIX)
164 .TP
165 SRCH_URL
166 the format string used to define the option to re-search the
167 database.
168 .TP
169 REF_URL
170 the format string used to define the option to lookup the library
171 sequence in entrez, or some other database.
172
173 .SH AUTHOR
174 Bill Pearson
175 .br
176 wrp@virginia.EDU