Source code

Download source archive ↓

upstream-extended/iuc/tool_collections/samtools/samtools_stats/samtools_stats.xml

1<tool id="samtools_stats" name="Samtools stats" version="2.0.9" profile="@PROFILE@">
2    <description>generate statistics for BAM dataset</description>
3    <macros>
4        <import>macros.xml</import>
5    </macros>
6    <expand macro="requirements"/>
7    <expand macro="stdio"/>
8    <expand macro="version_command"/>
9    <command><![CDATA[
10        @ADDTHREADS@
11        @PREPARE_IDX@
12        @PREPARE_FASTA_IDX@
13        samtools stats
14            #if $coverage_cond.coverage_select == 'yes':
15                --coverage ${coverage_cond.coverage_min},${coverage_cond.coverage_max},${coverage_cond.coverage_step}
16            #end if
17            ${remove_dups}
18            #if str( $filter_by_flags.filter_flags ) == "filter":
19                #set $filter = $filter_by_flags.require_flags
20                @FLAGS@
21                --required-flag $flags
22                #set $filter = $filter_by_flags.exclude_flags
23                @FLAGS@
24                --filtering-flag $flags
25            #end if
26            #if str($gc_depth):
27                --GC-depth ${gc_depth}
28            #end if
29            #if str($insert_size):
30                --insert-size ${insert_size}
31            #end if
32            ## #if $read_group
33            ##    -I '$read_group'
34            ## #end if
35            #if str($read_length):
36                --read-length ${read_length}
37            #end if
38            #if str($most_inserts):
39                --most-inserts ${most_inserts}
40            #end if
41            #if str($trim_quality):
42                --trim-quality ${trim_quality}
43            #end if
44
45            #if $use_ref:
46                --ref-seq "\$reffa"
47            #end if
48            ## currently not implemented in Galaxy
49            ## generates STR_VALUE.bamstat where STR is given by -P and VALUE is a value of the TAG given by -S
50            ## needs some discover data sets action...
51            ## -P, --split-prefix STR
52            ## -S, --split TAG
53            $sparse
54            @REGIONS_FILE@
55            $remove_overlaps
56            #if str($cov_threshold):
57                -g $cov_threshold
58            #end if
59            -@ \$addthreads
60            infile
61            @REGIONS_MANUAL@
62            > '$output'
63
64            #if $split_output_cond.split_output_selector == "yes":
65                #set outputs_to_split = str($split_output_cond.generate_tables).split(',')
66                && mkdir split
67                #for s in str($split_output_cond.generate_tables).split(','):
68                    && name=`cat '$output' | grep '\^$s' | cut -d'.' -f 1 | sed 's/^# //'`
69                    && awk '/\^/{out=0} /\^$s/{out=1} {if(out==1){print $0}}' '$output' | sed 's/Use `grep .*` to extract this part.//' | sed 's/$s\t//' > "split/\$name.tab"
70                #end for
71            #end if
72    ]]></command>
73    <inputs>
74        <param name="input" type="data" format="sam,bam,cram" label="BAM file" />
75        <conditional name="coverage_cond">
76            <param name="coverage_select" type="select" label="Set coverage distribution">
77                <option value="no" selected="True">No</option>
78                <option value="yes">Yes</option>
79            </param>
80            <when value="no"/>
81            <when value="yes">
82                <param name="coverage_min" type="integer" value="1" label="Minimum coverage" help="Minimum coverage" />
83                <param name="coverage_max" type="integer" value="1000" label="Maximum coverage" help="Maximum coverage" />
84                <param name="coverage_step" type="integer" value="1" label="Coverage step" help="Step value for coverage" />
85            </when>
86        </conditional>
87        <param argument="--remove-dups" type="boolean" truevalue="--remove-dups" falsevalue="" checked="False" label="Exclude reads marked as duplicates" />
88        <conditional name="split_output_cond">
89            <param name="split_output_selector" type="select" label="Output" help="Select between one single output or separate outputs for each statistics">
90                <option value="no" selected="True">One single summary file</option>
91                <option value="yes">Separate datasets for each statistic</option>
92            </param>
93            <when value="no" />
94            <when value="yes">
95                <param name="generate_tables" type="select" display="checkboxes" multiple="True" label="Desired output files">
96                    <option value="SN">Summary numbers</option>
97                    <option value="FFQ">First Fragment Qualities</option>
98                    <option value="LFQ">Last Fragment Qualities</option>
99                    <option value="MPC">Mismatches per cycle</option>
100                    <option value="GCF">GC Content of first fragments</option>
101                    <option value="GCL">GC Content of last fragments</option>
102                    <option value="GCC">ACGT content per cycle</option>
103                    <option value="FBC">ACGT content per cycle for first fragments</option>
104                    <option value="LBC">ACGT content per cycle for last fragments</option>
105                    <option value="IS">Insert sizes</option>
106                    <option value="RL">Read lengths</option>
107                    <option value="FRL">Read lengths for first fragments</option>
108                    <option value="LRL">Read lengths for last fragments</option>
109                    <option value="ID">Indel distribution</option>
110                    <option value="IC">Indels per cycle</option>
111                    <option value="COV">Coverage distribution</option>
112                    <option value="GCD">GC depth</option>
113                </param>
114            </when>
115        </conditional>
116        <conditional name="filter_by_flags">
117            <param name="filter_flags" type="select" label="Filter by SAM flags" help="More info on the flags: https://samtools.github.io/hts-specs/SAMv1.pdf">
118                <option value="nofilter" selected="True">Do not filter</option>
119                <option value="filter">Filter by flags to exclude or require</option>
120            </param>
121            <when value="filter">
122                <param name="require_flags" argument="-f" type="select" display="checkboxes" multiple="True" label="Require">
123                    <expand macro="flag_options" />
124                </param>
125                <param name="exclude_flags" argument="-F" type="select" display="checkboxes" multiple="True" label="Exclude">
126                    <expand macro="flag_options" />
127                </param>
128            </when>
129            <when value="nofilter" />
130
131        </conditional>
132        <!-- TODO I would like to set the default values of float and int parameters as on the samtools stats help page, but then the tests don't work. Hence I leave the optional and give the defaults in the help -->
133        <param name="gc_depth" argument="--GC-depth" type="float" optional="True" label="Size of GC-depth bins" help="Decreasing bin size increases memory requirement. default=2e4" />
134        <param argument="--insert-size" type="integer" optional="True" label="Maximum insert size" help="default=8000" />
135        <!-- TOOD https://github.com/samtools/samtools/issues/1489 -->    
136        <param name="read_group" argument="--id" type="select" optional="true" label="Limit to a specific read group name" >
137            <options>
138                <filter type="data_meta" ref="input" key="read_groups" />
139            </options>
140        </param>
141        <param argument="--read-length" type="integer" optional="true" label="Minimum read length to generate statistics for" help="No cutoff if left empty" />
142        <param argument="--most-inserts" type="float" optional="true" label="Report only the main part of inserts" help="default=0.99" />
143        <param argument="--trim-quality" type="integer" optional="true" label="BWA trim parameter" help="default=0" />
144
145        <expand macro="optional_reference" argument="--ref-seq" help="Required for GC-depth and mismatches-per-cycle calculation"/>
146        <!-- unfortunately -t takes tabular and not bed like view (otherwise a macro might have simplified this) -->
147
148        <expand macro="regions_macro"/>
149
150        <param name="sparse" argument="-x/--sparse" type="boolean" truevalue="-x" falsevalue="" checked="False" label="Suppress absence of insertions" help="Suppress outputting IS rows where there are no insertions."/>
151        <param name="remove_overlaps" argument="-p/--remove-overlaps" type="boolean" truevalue="-p" falsevalue="" checked="False" label="Remove overlaps of paired-end reads from coverage and base count computations" />
152        <param name="cov_threshold" argument="-g/--cov-threshold"  optional="true" type="integer" label="Only bases with coverage above this value will be included in the target percentage computation" />
153    </inputs>
154
155    <outputs>
156        <data name="output" format="tabular">
157            <filter>split_output_cond['split_output_selector'] == 'no'</filter>
158        </data>
159        <collection name="output_collection" type="list" label="${tool.name} on ${on_string}: separate statistics">
160            <discover_datasets directory="split" pattern="(?P&lt;designation&gt;.+)\.tab" format="tabular" visible="false"/>
161            <filter>split_output_cond['split_output_selector'] == 'yes'</filter>
162        </collection>
163    </outputs>
164    <tests>
165        <!-- https://github.com/samtools/samtools/blob/9ce8c64493f7ea3fa69bc5c1ac980b1a8e3dcf1f/test/test.pl#L2402 -->
166        <test expect_num_outputs="1">
167            <param name="input" value="1_map_cigar.sam" ftype="sam" />
168            <conditional name="addref_cond">
169                <param name="addref_select" value="history" />
170                <param name="ref" value="test.fa" ftype="fasta" />
171            </conditional>
172            <output name="output" file="1.stats.expected" ftype="tabular" lines_diff="8" />
173        </test>
174        <!-- test_cmd($opts,out=>'stat/1.stats.expected',cmd=>"$$opts{bin}/samtools stats -r $$opts{path}/stat/test.fa $$opts{path}/stat/1_map_cigar.sam | tail -n+4", exp_fix=>$efix);-->
175        <test expect_num_outputs="1">
176            <param name="input" value="2_equal_cigar_full_seq.sam" ftype="sam" />
177            <conditional name="addref_cond">
178                <param name="addref_select" value="cached" />
179                <param name="ref" value="test" />
180            </conditional>
181            <output name="output" file="2.stats.expected" ftype="tabular" lines_diff="8" />
182        </test>
183        <!-- test_cmd($opts,out=>'stat/2.stats.expected',cmd=>"$$opts{bin}/samtools stats -r $$opts{path}/stat/test.fa $$opts{path}/stat/2_equal_cigar_full_seq.sam | tail -n+4", exp_fix=>$efix);-->
184        <!-- test_cmd($opts,out=>'stat/3.stats.expected',cmd=>"$$opts{bin}/samtools stats -r $$opts{path}/stat/test.fa $$opts{path}/stat/3_map_cigar_equal_seq.sam | tail -n+4", exp_fix=>$efix);-->
185        <!-- test_cmd($opts,out=>'stat/4.stats.expected',cmd=>"$$opts{bin}/samtools stats -r $$opts{path}/stat/test.fa $$opts{path}/stat/4_X_cigar_full_seq.sam | tail -n+4", exp_fix=>$efix);-->
186        <!-- test_cmd($opts,out=>'stat/5.stats.expected',cmd=>"$$opts{bin}/samtools stats -r $$opts{path}/stat/test.fa $$opts{path}/stat/5_insert_cigar.sam | tail -n+4", exp_fix=>$efix); -->
187        <test expect_num_outputs="1">
188            <param name="input" value="5_insert_cigar.sam" ftype="sam" />
189            <param name="insert_size" value="0" />
190            <conditional name="addref_cond">
191                <param name="addref_select" value="history" />
192                <param name="ref" value="test.fa" ftype="fasta" />
193            </conditional>
194            <output name="output" file="6.stats.expected" ftype="tabular" lines_diff="8" />
195        </test>
196        <!-- test_cmd($opts,out=>'stat/6.stats.expected',cmd=>"$$opts{bin}/samtools stats -r $$opts{path}/stat/test.fa -i 0 $$opts{path}/stat/5_insert_cigar.sam | tail -n+4", exp_fix=>$efix); -->
197        <!-- test_cmd($opts,out=>'stat/7.stats.expected',cmd=>"$$opts{bin}/samtools stats -r $$opts{path}/stat/test.fa $$opts{path}/stat/7_supp.sam | tail -n+4", exp_fix=>$efix); -->
198        <!-- test_cmd($opts,out=>'stat/8.stats.expected',cmd=>"$$opts{bin}/samtools stats -r $$opts{path}/stat/test.fa $$opts{path}/stat/8_secondary.sam | tail -n+4", exp_fix=>$efix);-->
199        <!-- test_cmd($opts,out=>'stat/9.stats.expected',cmd=>"$$opts{bin}/samtools stats -S RG -r $$opts{path}/stat/test.fa $$opts{path}/stat/1_map_cigar.sam | tail -n+4", exp_fix=>$efix,out_map=>{"stat/1_map_cigar.sam_s1_a_1.bamstat"=>"stat/1_map_cigar.sam_s1_a_1.expected.bamstat"},hskip=>3);-->
200        <!-- test_cmd($opts,out=>'stat/10.stats.expected',cmd=>"$$opts{bin}/samtools stats -S RG -r $$opts{path}/stat/test.fa $$opts{path}/stat/10_map_cigar.sam | tail -n+4", exp_fix=>$efix,out_map=>{"stat/10_map_cigar.sam_s1_a_1.bamstat"=>"stat/10_map_cigar.sam_s1_a_1.expected.bamstat", "stat/10_map_cigar.sam_s1_b_1.bamstat"=>"stat/10_map_cigar.sam_s1_b_1.expected.bamstat"},hskip=>3);-->
201        <test expect_num_outputs="1">
202            <param name="input" value="11_target.sam" ftype="sam" />
203            <conditional name="addref_cond">
204                <param name="addref_select" value="no" />
205            </conditional>
206            <conditional name="cond_region">
207                <param name="select_region" value="tab"/>
208                <param name="targetregions" value="11.stats.targets" ftype="tabular" />
209            </conditional>
210            <output name="output" file="11.stats.expected" ftype="tabular" lines_diff="8" />
211        </test>
212        <!-- test_cmd($opts,out=>'stat/11.stats.expected',cmd=>"$$opts{bin}/samtools stats -t $$opts{path}/stat/11.stats.targets $$opts{path}/stat/11_target.sam | tail -n+4", exp_fix=>$efix); -->
213
214        <test expect_num_outputs="1">
215            <param name="input" value="11_target.bam" ftype="bam" />
216            <conditional name="addref_cond">
217                <param name="addref_select" value="no" />
218            </conditional>
219            <conditional name="cond_region">
220                <param name="select_region" value="text"/>
221                <param name="regions_repeat_0|region" value="ref1:10-24"/>
222                <param name="regions_repeat_1|region" value="ref1:30-46"/>
223                <param name="regions_repeat_2|region" value="ref1:39-56"/>
224            </conditional>
225            <output name="output" file="11.stats.expected" ftype="tabular" lines_diff="8" />
226        </test>
227        <!-- test_cmd($opts,out=>'stat/11.stats.expected',cmd=>"$$opts{bin}/samtools stats $$opts{path}/stat/11_target.bam ref1:10-24 ref1:30-46 ref1:39-56 | tail -n+4", exp_fix=>$efix);
228-->
229        <test expect_num_outputs="1">
230            <param name="input" value="11_target.sam" ftype="sam" />
231            <conditional name="addref_cond">
232                <param name="addref_select" value="no" />
233            </conditional>
234            <conditional name="cond_region">
235                <param name="select_region" value="tab"/>
236                <param name="targetregions" value="11.stats.targets" ftype="tabular" />
237            </conditional>
238            <param name="cov_threshold" value="4" />
239            <output name="output" file="11.stats.g4.expected" ftype="tabular" lines_diff="8" />
240        </test>
241        <!-- test_cmd($opts,out=>'stat/11.stats.g4.expected',cmd=>"$$opts{bin}/samtools stats -g 4 -t $$opts{path}/stat/11.stats.targets $$opts{path}/stat/11_target.sam | tail -n+4", exp_fix=>$efix);-->
242        <test expect_num_outputs="1">
243            <param name="input" value="11_target.bam" ftype="bam" />
244            <conditional name="addref_cond">
245                <param name="addref_select" value="no" />
246            </conditional>
247            <conditional name="cond_region">
248                <param name="select_region" value="text"/>
249                <param name="regions_repeat_0|region" value="ref1:10-24"/>
250                <param name="regions_repeat_1|region" value="ref1:30-46"/>
251                <param name="regions_repeat_2|region" value="ref1:39-56"/>
252            </conditional>
253            <param name="cov_threshold" value="4" />
254            <output name="output" file="11.stats.g4.expected" ftype="tabular" lines_diff="8" />
255        </test>
256        <!-- test_cmd($opts,out=>'stat/11.stats.g4.expected',cmd=>"$$opts{bin}/samtools stats -g 4 $$opts{path}/stat/11_target.bam ref1:10-24 ref1:30-46 ref1:39-56 | tail -n+4", exp_fix=>$efix); -->
257        <test expect_num_outputs="1">
258            <param name="input" value="12_overlaps.bam" ftype="bam" />
259            <conditional name="addref_cond">
260                <param name="addref_select" value="no" />
261            </conditional>
262            <conditional name="cond_region">
263                <param name="select_region" value="tab"/>
264                <param name="targetregions" value="12_3reads.bed" ftype="tabular" />
265            </conditional>
266            <output name="output" file="12.3reads.overlap.expected" ftype="tabular" lines_diff="8" />
267        </test>
268        <!-- test_cmd($opts,out=>'stat/12.3reads.overlap.expected',cmd=>"$$opts{bin}/samtools stats $$opts{path}/stat/12_overlaps.bam -t $$opts{path}/stat/12_3reads.bed | tail -n+4", exp_fix=>$efix);-->
269        <test expect_num_outputs="1">
270            <param name="input" value="12_overlaps.bam" ftype="bam" />
271            <conditional name="addref_cond">
272                <param name="addref_select" value="no" />
273            </conditional>
274            <conditional name="cond_region">
275                <param name="select_region" value="tab"/>
276                <param name="targetregions" value="12_3reads.bed" ftype="tabular" />
277            </conditional>
278            <param name="remove_overlaps" value="true"/>
279            <output name="output" file="12.3reads.nooverlap.expected" ftype="tabular" lines_diff="8" />
280        </test>
281        <!-- test_cmd($opts,out=>'stat/12.3reads.nooverlap.expected',cmd=>"$$opts{bin}/samtools stats $$opts{path}/stat/12_overlaps.bam -p -t $$opts{path}/stat/12_3reads.bed | tail -n+4", exp_fix=>$efix);-->
282        <test expect_num_outputs="1">
283            <param name="input" value="12_overlaps.bam" ftype="bam" />
284            <conditional name="addref_cond">
285                <param name="addref_select" value="no" />
286            </conditional>
287            <conditional name="cond_region">
288                <param name="select_region" value="tab"/>
289                <param name="targetregions" value="12_2reads.bed" ftype="tabular" />
290            </conditional>
291            <output name="output" file="12.2reads.overlap.expected" ftype="tabular" lines_diff="8" />
292        </test>
293        <!-- test_cmd($opts,out=>'stat/12.2reads.overlap.expected',cmd=>"$$opts{bin}/samtools stats $$opts{path}/stat/12_overlaps.bam -t $$opts{path}/stat/12_2reads.bed | tail -n+4", exp_fix=>$efix);-->
294        <test expect_num_outputs="1">
295            <param name="input" value="12_overlaps.bam" ftype="bam" />
296            <conditional name="addref_cond">
297                <param name="addref_select" value="no" />
298            </conditional>
299            <conditional name="cond_region">
300                <param name="select_region" value="tab"/>
301                <param name="targetregions" value="12_2reads.bed" ftype="tabular" />
302            </conditional>
303            <param name="remove_overlaps" value="true"/>
304            <output name="output" file="12.2reads.nooverlap.expected" ftype="tabular" lines_diff="8" />
305        </test>
306        <!-- test_cmd($opts,out=>'stat/12.2reads.nooverlap.expected',cmd=>"$$opts{bin}/samtools stats $$opts{path}/stat/12_overlaps.bam -p -t $$opts{path}/stat/12_2reads.bed | tail -n+4", exp_fix=>$efix);-->
307        <test expect_num_outputs="1">
308            <param name="input" value="samtools_stats_input.bam" ftype="bam" />
309            <conditional name="addref_cond">
310                <param name="addref_select" value="history" />
311                <param name="ref" value="samtools_stats_ref.fa" ftype="fasta" />
312            </conditional>
313            <output name="output" file="samtools_stats_out1.tab" ftype="tabular" lines_diff="8" />
314        </test>
315        <test expect_num_outputs="1">
316            <param name="input" value="samtools_stats_input.bam" ftype="bam" />
317            <conditional name="addref_cond">
318                <param name="addref_select" value="history" />
319                <param name="ref" value="samtools_stats_ref.fa" ftype="fasta" />
320            </conditional>
321            <conditional name="split_output_cond">
322                <param name="split_output_selector" value="yes" />
323                <param name="generate_tables" value="SN,MPC,GCC" />
324            </conditional>
325            <output_collection name="output_collection" type="list">
326                <element name="ACGT content per cycle" ftype="tabular" file="samtools_stats_out1__gcc.tab"/>
327                <element name="Mismatches per cycle and quality" ftype="tabular" file="samtools_stats_out1__mpc.tab" />
328                <element name="Summary Numbers" ftype="tabular" file="samtools_stats_out1__sn.tab" lines_diff="2" />
329            </output_collection>
330        </test>
331        <!-- test filtering by read group -->
332        <!-- <test>
333            <param name="input" value="11_target.sam" ftype="sam" />
334            <conditional name="addref_cond">
335                <param name="addref_select" value="no" />
336            </conditional>
337            <param name="read_group" value="grp1" />
338            <output name="output" file="11.stats.read_groups.expected" ftype="tabular" lines_diff="2" />
339            <assert_command>
340                <has_text text="-I 'grp1'"/>
341            </assert_command>
342        </test> -->
343    </tests>
344    <help><![CDATA[
345**What it does**
346
347This tool runs the ``samtools stats`` command.
348
349The results of samtools stats can be visualized with MultiQC (for this the default of a single output file needs to be selected).
350    ]]></help>
351    <expand macro="citations"/>
352</tool>