ensure we never check in autogenerated documentation or build artefacts
[jabaws.git] / conf / temp / psiblast.txt
1  /local/gjb_lab/blast+/bin/psiblast -help\r
2 USAGE\r
3   psiblast [-h] [-help] [-import_search_strategy filename]\r
4     [-export_search_strategy filename] [-db database_name]\r
5     [-dbsize num_letters] [-gilist filename] [-negative_gilist filename]\r
6     [-entrez_query entrez_query] [-subject subject_input_file]\r
7     [-subject_loc range] [-query input_file] [-out output_file]\r
8     [-evalue evalue] [-word_size int_value] [-gapopen open_penalty]\r
9     [-gapextend extend_penalty] [-xdrop_ungap float_value]\r
10     [-xdrop_gap float_value] [-xdrop_gap_final float_value]\r
11     [-searchsp int_value] [-seg SEG_options] [-soft_masking soft_masking]\r
12     [-matrix matrix_name] [-threshold float_value] [-culling_limit int_value]\r
13     [-best_hit_overhang float_value] [-best_hit_score_edge float_value]\r
14     [-window_size int_value] [-lcase_masking] [-query_loc range]\r
15     [-parse_deflines] [-outfmt format] [-show_gis]\r
16     [-num_descriptions int_value] [-num_alignments int_value] [-html]\r
17     [-max_target_seqs num_sequences] [-num_threads int_value] [-remote]\r
18     [-comp_based_stats compo] [-use_sw_tback] [-gap_trigger float_value]\r
19     [-num_iterations int_value] [-out_pssm checkpoint_file]\r
20     [-out_ascii_pssm ascii_mtx_file] [-in_msa align_restart]\r
21     [-in_pssm psi_chkpt_file] [-pseudocount pseudocount]\r
22     [-inclusion_ethresh ethresh] [-phi_pattern file] [-version]\r
23 \r
24 DESCRIPTION\r
25    Position-Specific Initiated BLAST 2.2.22+\r
26 \r
27 OPTIONAL ARGUMENTS\r
28  -h\r
29    Print USAGE and DESCRIPTION;  ignore other arguments\r
30  -help\r
31    Print USAGE, DESCRIPTION and ARGUMENTS description;  ignore other arguments\r
32  -version\r
33    Print version number;  ignore other arguments\r
34 \r
35  *** Input query options\r
36  -query <File_In>\r
37    Input file name\r
38    Default = `-'\r
39     * Incompatible with:  in_msa, in_pssm\r
40  -query_loc <String>\r
41    Location on the query sequence (Format: start-stop)\r
42 \r
43  *** General search options\r
44  -db <String>\r
45    BLAST database name\r
46     * Incompatible with:  subject, subject_loc\r
47  -out <File_Out>\r
48    Output file name\r
49    Default = `-'\r
50  -evalue <Real>\r
51    Expectation value (E) threshold for saving hits\r
52    Default = `10'\r
53  -word_size <Integer, >=2>\r
54    Word size for wordfinder algorithm\r
55  -gapopen <Integer>\r
56    Cost to open a gap\r
57  -gapextend <Integer>\r
58    Cost to extend a gap\r
59  -matrix <String>\r
60    Scoring matrix name\r
61    Default = `BLOSUM62'\r
62  -threshold <Real, >=0>\r
63    Minimum word score such that the word is added to the BLAST lookup table\r
64  -comp_based_stats <String>\r
65    Use composition-based statistics for blastp / tblastn:\r
66        D or d: default (equivalent to 2)\r
67        0 or F or f: no composition-based statistics\r
68        1: Composition-based statistics as in NAR 29:2994-3005, 2001\r
69        2 or T or t : Composition-based score adjustment as in Bioinformatics\r
70    21:902-911,\r
71        2005, conditioned on sequence properties\r
72        3: Composition-based score adjustment as in Bioinformatics 21:902-911,\r
73        2005, unconditionally\r
74    For programs other than tblastn, must either be absent or be D, F or 0\r
75    Default = `2'\r
76 \r
77  *** BLAST-2-Sequences options\r
78  -subject <File_In>\r
79    Subject sequence(s) to search\r
80     * Incompatible with:  db, gilist, negative_gilist\r
81  -subject_loc <String>\r
82    Location on the subject sequence (Format: start-stop)\r
83     * Incompatible with:  db, gilist, negative_gilist, remote\r
84 \r
85  *** Formatting options\r
86  -outfmt <String>\r
87    alignment view options:\r
88      0 = pairwise,\r
89      1 = query-anchored showing identities,\r
90      2 = query-anchored no identities,\r
91      3 = flat query-anchored, show identities,\r
92      4 = flat query-anchored, no identities,\r
93      5 = XML Blast output,\r
94      6 = tabular,\r
95      7 = tabular with comment lines,\r
96      8 = Text ASN.1,\r
97      9 = Binary ASN.1\r
98     10 = Comma-separated values\r
99 \r
100    Options 6, 7, and 10 can be additionally configured to produce\r
101    a custom format specified by space delimited format specifiers.\r
102    The supported format specifiers are:\r
103             qseqid means Query Seq-id\r
104                qgi means Query GI\r
105               qacc means Query accesion\r
106             sseqid means Subject Seq-id\r
107          sallseqid means All subject Seq-id(s), separated by a ';'\r
108                sgi means Subject GI\r
109             sallgi means All subject GIs\r
110               sacc means Subject accession\r
111            sallacc means All subject accessions\r
112             qstart means Start of alignment in query\r
113               qend means End of alignment in query\r
114             sstart means Start of alignment in subject\r
115               send means End of alignment in subject\r
116               qseq means Aligned part of query sequence\r
117               sseq means Aligned part of subject sequence\r
118             evalue means Expect value\r
119           bitscore means Bit score\r
120              score means Raw score\r
121             length means Alignment length\r
122             pident means Percentage of identical matches\r
123             nident means Number of identical matches\r
124           mismatch means Number of mismatches\r
125           positive means Number of positive-scoring matches\r
126            gapopen means Number of gap openings\r
127               gaps means Total number of gaps\r
128               ppos means Percentage of positive-scoring matches\r
129             frames means Query and subject frames separated by a '/'\r
130             qframe means Query frame\r
131             sframe means Subject frame\r
132    When not provided, the default value is:\r
133    'qseqid sseqid pident length mismatch gapopen qstart qend sstart send\r
134    evalue bitscore', which is equivalent to the keyword 'std'\r
135    Default = `0'\r
136  -show_gis\r
137    Show NCBI GIs in deflines?\r
138  -num_descriptions <Integer, >=0>\r
139    Number of database sequences to show one-line descriptions for\r
140    Default = `500'\r
141  -num_alignments <Integer, >=0>\r
142    Number of database sequences to show alignments for\r
143    Default = `250'\r
144  -html\r
145    Produce HTML output?\r
146 \r
147  *** Query filtering options\r
148  -seg <String>\r
149    Filter query sequence with SEG (Format: 'yes', 'window locut hicut', or\r
150    'no' to disable)\r
151    Default = `no'\r
152  -soft_masking <Boolean>\r
153    Apply filtering locations as soft masks\r
154    Default = `false'\r
155  -lcase_masking\r
156    Use lower case filtering in query and subject sequence(s)?\r
157 \r
158  *** Restrict search or results\r
159  -gilist <String>\r
160    Restrict search of database to list of GI's\r
161     * Incompatible with:  negative_gilist, remote, subject, subject_loc\r
162  -negative_gilist <String>\r
163    Restrict search of database to everything except the listed GIs\r
164     * Incompatible with:  gilist, remote, subject, subject_loc\r
165  -entrez_query <String>\r
166    Restrict search with the given Entrez query\r
167     * Requires:  remote\r
168  -culling_limit <Integer, >=0>\r
169    If the query range of a hit is enveloped by that of at least this many\r
170    higher-scoring hits, delete the hit\r
171     * Incompatible with:  best_hit_overhang, best_hit_score_edge\r
172  -best_hit_overhang <Real, (>=0 and =<0.5)>\r
173    Best Hit algorithm overhang value (recommended value: 0.1)\r
174     * Incompatible with:  culling_limit\r
175  -best_hit_score_edge <Real, (>=0 and =<0.5)>\r
176    Best Hit algorithm score edge value (recommended value: 0.1)\r
177     * Incompatible with:  culling_limit\r
178  -max_target_seqs <Integer, >=1>\r
179    Maximum number of aligned sequences to keep\r
180 \r
181  *** Statistical options\r
182  -dbsize <Int8>\r
183    Effective length of the database\r
184  -searchsp <Int8, >=0>\r
185    Effective length of the search space\r
186 \r
187  *** Search strategy options\r
188  -import_search_strategy <File_In>\r
189    Search strategy to use\r
190     * Incompatible with:  export_search_strategy\r
191  -export_search_strategy <File_Out>\r
192    File name to record the search strategy used\r
193     * Incompatible with:  import_search_strategy\r
194 \r
195  *** Extension options\r
196  -xdrop_ungap <Real>\r
197    X-dropoff value (in bits) for ungapped extensions\r
198  -xdrop_gap <Real>\r
199    X-dropoff value (in bits) for preliminary gapped extensions\r
200  -xdrop_gap_final <Real>\r
201    X-dropoff value (in bits) for final gapped alignment\r
202  -window_size <Integer, >=0>\r
203    Multiple hits window size, use 0 to specify 1-hit algorithm\r
204  -gap_trigger <Real>\r
205    Number of bits to trigger gapping\r
206    Default = `22'\r
207 \r
208  *** Miscellaneous options\r
209  -parse_deflines\r
210    Should the query and subject defline(s) be parsed?\r
211  -num_threads <Integer, >=1>\r
212    Number of threads to use in the BLAST search\r
213    Default = `1'\r
214     * Incompatible with:  remote\r
215  -remote\r
216    Execute search remotely?\r
217     * Incompatible with:  gilist, negative_gilist, subject_loc, num_threads,\r
218    num_iterations\r
219  -use_sw_tback\r
220    Compute locally optimal Smith-Waterman alignments?\r
221 \r
222  *** PSI-BLAST options\r
223  -num_iterations <Integer, >=1>\r
224    Number of iterations to perform\r
225    Default = `1'\r
226     * Incompatible with:  remote\r
227  -out_pssm <File_Out>\r
228    File name to store checkpoint file\r
229  -out_ascii_pssm <File_Out>\r
230    File name to store ASCII version of PSSM\r
231  -in_msa <File_In>\r
232    File name of multiple sequence alignment to restart PSI-BLAST\r
233     * Incompatible with:  in_pssm, query\r
234  -in_pssm <File_In>\r
235    PSI-BLAST checkpoint file\r
236     * Incompatible with:  in_msa, query, phi_pattern\r
237 \r
238  *** PSSM engine options\r
239  -pseudocount <Integer>\r
240    Pseudo-count value used when constructing PSSM\r
241    Default = `0'\r
242  -inclusion_ethresh <Real>\r
243    E-value inclusion threshold for pairwise alignments\r
244    Default = `0.002'\r
245 \r
246  *** PHI-BLAST options\r
247  -phi_pattern <File_In>\r
248    File name containing pattern to search\r
249     * Incompatible with:  in_pssm\r