annotate ribopicker.xml @ 0:98d76a28cc24 draft default tip

Uploaded
author jjohnson
date Thu, 25 Oct 2012 13:14:50 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
1 <tool id="ribopicker" name="Ribopicker" version="1.0">
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
2 <description>identify and remove rRNA-like sequences</description>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
3 <requirements>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
4 </requirements>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
5 <command interpreter="perl">
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
6 ribopicker.pl -f $input -dbs $dbs -id results
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
7 </command>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
8 <inputs>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
9 <param name="input" type="data" format="fastq,fasta" label="Input Sequences"/>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
10 <param name="dbs" type="select" label="Databases" multiple="true">
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
11 <!-- from riboPickerConfig.pm -->
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
12 <option value="rrnadb">rrnadb - Non-redundant Ribosomal RNA Database</option>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
13 <option value="slr">slr - SILVA Large subunit reference database (23S/28S)</option>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
14 <option value="ssr">ssr - SILVA Small subunit reference database (16S/18S)</option>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
15 <option value="test">test - Example test case db</option>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
16 </param>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
17 <param name="identity" type="integer" optional="true" label=" Alignment identity threshold percentage (1-100)">
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
18 <help>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
19 Alignment identity threshold in percentage (integer from 1-100
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
20 without %) used to define matching sequences as similar. The
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
21 identity is calculated for the part of the query sequence that
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
22 is aligned to a reference sequence. For example, a query
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
23 sequence of 100 bp that aligns to a reference sequence over the
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
24 first 50 bp with 40 matching positions has an identity value of
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
25 80%."
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
26 </help>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
27 <validator type="in_range" message="between 0 and 100" min="1" max="100"/>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
28 </param>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
29 <param name="coverage" type="integer" optional="true" label="Alignment coverage threshold percentage (1-100)">
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
30 <help>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
31 Alignment coverage threshold in percentage (integer from 1-100
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
32 without %) used to define matching sequences as similar. The
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
33 coverage is calculated for the part of the query sequence that
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
34 is aligned to a reference sequence. For example, a query
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
35 sequence of 100 bp that aligns to a reference sequence over the
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
36 first 50 bp with 40 matching positions has an coverage value of
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
37 50%.
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
38 </help>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
39 <validator type="in_range" message="between 0 and 100" min="1" max="100"/>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
40 </param>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
41
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
42 <param name="length" type="integer" optional="true" label="Alignment length threshold">
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
43 <help>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
44 Alignment length threshold used to define matching sequences as
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
45 similar. For example, a query sequence of 100 bp that aligns to
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
46 a reference sequence over the first 50 bp with 40 matching
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
47 positions has an alignment length of 50.
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
48 </help>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
49 <validator type="in_range" message="length needs to be positive" min="1"/>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
50 </param>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
51
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
52 <param name="chunk_size" type="integer" optional="true" label="Chunk size of reads in bp as used by BWA-SW (default: 10000000)">
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
53 <validator type="in_range" message="" min="10000" max="100"/>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
54 </param>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
55 <param name="z_best" type="integer" optional="true" label="Z-best value as used by BWA-SW (default: 1)">
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
56 <validator type="in_range" message="" min="1" max="10"/>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
57 </param>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
58 <param name="score" type="integer" optional="true" label="Alignment score threshold as used by BWA-SW (default: 30)">
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
59 <validator type="in_range" message="" min="1" max="10"/>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
60 </param>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
61
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
62 </inputs>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
63 <outputs>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
64 <data format_source="input" name="rrna_fa" label="rrna from ${on_string}" from_work_dir="results_rrna.fa">
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
65 <filter>input.extension.find('fasta') >= 0</filter>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
66 </data>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
67 <data format_source="input" name="nonrrna_fa" label="non rrna from ${on_string}" from_work_dir="results_nonrrna.fa">
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
68 <filter>input.extension.find('fasta') >= 0</filter>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
69 </data>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
70 <data format_source="input" name="rrna_fq" label="rrna from ${on_string}" from_work_dir="results_rrna.fq">
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
71 <filter>input.extension.find('fastq') >= 0</filter>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
72 </data>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
73 <data format_source="input" name="nonrrna_fq" label="non rrna from ${on_string}" from_work_dir="results_nonrrna.fq">
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
74 <filter>input.extension.find('fastq') >= 0</filter>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
75 </data>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
76 </outputs>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
77 <!--
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
78 <stdio>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
79 <exit_code range=":-1" level="fatal" description="Error: Cannot open file" />
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
80 <exit_code range="1:" level="fatal" description="Error" />
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
81 </stdio>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
82 -->
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
83
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
84 <help>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
85
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
86 <!--
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
87 Usage:
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
88 ribopicker [options] -f <file> -dbs <list> ...
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
89
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
90 Options:
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
91 -help | -h
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
92 Prints the help message and exists.
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
93
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
94 -man Prints the full documentation.
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
95
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
96 -version
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
97 Prints the version of the program.
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
98
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
99 -show_dbs
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
100 Prints a list of available databases.
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
101
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
102 -f <file>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
103 Input file in FASTA or FASTQ format that contains the query
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
104 sequences.
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
105
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
106 -dbs <list>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
107 Name of database(s) to use (default: ssr). Names are according
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
108 to their definition in the config file (riboPickerConfig.pm).
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
109 Separate multiple database names by comma without spaces.
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
110
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
111 Example: -dbs ssr,hmp16s,ncbi16s
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
112
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
113 -out_dir <dir>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
114 Directory where the results should be written (default: .). If
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
115 the directory does not exist, it will be created.
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
116
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
117 -i <integer>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
118 Alignment identity threshold in percentage (integer from 1-100
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
119 without %) used to define matching sequences as similar. The
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
120 identity is calculated for the part of the query sequence that
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
121 is aligned to a reference sequence. For example, a query
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
122 sequence of 100 bp that aligns to a reference sequence over the
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
123 first 50 bp with 40 matching positions has an identity value of
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
124 80%.
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
125
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
126 -c <integer>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
127 Alignment coverage threshold in percentage (integer from 1-100
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
128 without %) used to define matching sequences as similar. The
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
129 coverage is calculated for the part of the query sequence that
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
130 is aligned to a reference sequence. For example, a query
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
131 sequence of 100 bp that aligns to a reference sequence over the
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
132 first 50 bp with 40 matching positions has an coverage value of
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
133 50%.
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
134
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
135 -l <integer>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
136 Alignment length threshold used to define matching sequences as
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
137 similar. For example, a query sequence of 100 bp that aligns to
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
138 a reference sequence over the first 50 bp with 40 matching
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
139 positions has an alignment length of 50.
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
140
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
141 -no_seq_out
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
142 Prevents the generation of the fasta/fastq output file for the
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
143 given coverage and identity thresholds. This feature is e.g.
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
144 useful for the web-version since -i and -c are set interactively
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
145 and not yet defined at the data processing step.
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
146
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
147 -keep_tmp_files
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
148 Prevents from unlinking the generated tmp files. These usually
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
149 include the id file and the .tsv file(s). This feature is e.g.
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
150 useful for the web-version since .tsv files are used to
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
151 dynamically generate the output files.
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
152
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
153 -id <string>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
154 Optional parameter. If not set, ID will be automatically
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
155 generated to prevent from overwriting previous results. This
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
156 option is useful if integrated into other tools and the output
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
157 filenames need to be known. (Use this option to defined the
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
158 output filename prefix. Output files will end in _rrna.fa and
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
159 _nonrrna.fa, respectively.)
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
160
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
161 -S <integer>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
162 Chunk size of reads in bp as used by BWA-SW (default: 10000000).
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
163
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
164 -z <integer>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
165 Z-best value as used by BWA-SW (default: 1).
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
166
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
167 -T <integer>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
168 Alignment score threshold as used by BWA-SW (default: 30).
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
169
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
170 -->
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
171
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
172 </help>
98d76a28cc24 Uploaded
jjohnson
parents:
diff changeset
173 </tool>