annotate samtools_idxstats.xml @ 6:9a12e8643fc5 draft default tip

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
author iuc
date Tue, 28 Sep 2021 16:02:40 +0000
parents fd87401a3da6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
9a12e8643fc5 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 5
diff changeset
1 <tool id="samtools_idxstats" name="Samtools idxstats" version="2.0.4" profile="@PROFILE@">
2
e726bb429392 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 0
diff changeset
2 <description>reports stats of the BAM index file</description>
0
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
3 <macros>
2
e726bb429392 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 0
diff changeset
4 <import>macros.xml</import>
0
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
5 </macros>
2
e726bb429392 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 0
diff changeset
6 <expand macro="requirements"/>
e726bb429392 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 0
diff changeset
7 <expand macro="stdio"/>
e726bb429392 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 0
diff changeset
8 <expand macro="version_command"/>
0
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
9 <command><![CDATA[
4
56838051b673 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit a972815cbd43dea553b3c0e4ad548f35d0023228-dirty
iuc
parents: 3
diff changeset
10 @ADDTHREADS@
56838051b673 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit a972815cbd43dea553b3c0e4ad548f35d0023228-dirty
iuc
parents: 3
diff changeset
11 @PREPARE_IDX@
56838051b673 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit a972815cbd43dea553b3c0e4ad548f35d0023228-dirty
iuc
parents: 3
diff changeset
12 samtools idxstats -@ \$addthreads infile > '${output}'
2
e726bb429392 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 0
diff changeset
13 ]]></command>
0
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
14 <inputs>
3
20fea18b2830 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 70b38ebad0d0936f102e3e7cb70f1060347ea8c4
iuc
parents: 2
diff changeset
15 <param name="input" type="data" format="bam,cram" label="BAM file" />
0
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
16 </inputs>
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
17 <outputs>
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
18 <data format="tabular" name="output" label="${tool.name} on ${on_string}" />
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
19 </outputs>
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
20 <tests>
3
20fea18b2830 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 70b38ebad0d0936f102e3e7cb70f1060347ea8c4
iuc
parents: 2
diff changeset
21 <!-- test from https://github.com/samtools/samtools/blob/9ce8c64493f7ea3fa69bc5c1ac980b1a8e3dcf1f/test/test.pl#L2556 -->
0
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
22 <test>
3
20fea18b2830 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 70b38ebad0d0936f102e3e7cb70f1060347ea8c4
iuc
parents: 2
diff changeset
23 <param name="input" value="test_input_1_a.bam" ftype="bam" />
20fea18b2830 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 70b38ebad0d0936f102e3e7cb70f1060347ea8c4
iuc
parents: 2
diff changeset
24 <output name="output" file="test_input_1_a.bam.expected" compare="diff" ftype="tabular" />
20fea18b2830 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 70b38ebad0d0936f102e3e7cb70f1060347ea8c4
iuc
parents: 2
diff changeset
25 </test>
20fea18b2830 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 70b38ebad0d0936f102e3e7cb70f1060347ea8c4
iuc
parents: 2
diff changeset
26 <!-- test from original tool -->
20fea18b2830 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 70b38ebad0d0936f102e3e7cb70f1060347ea8c4
iuc
parents: 2
diff changeset
27 <test>
0
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
28 <param name="input" value="phiX.bam" ftype="bam" />
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
29 <output name="output" file="samtools_idxstats_out.tabular" compare="diff" ftype="tabular" />
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
30 </test>
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
31 </tests>
2
e726bb429392 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 0
diff changeset
32 <help><![CDATA[
0
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
33 **What it does**
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
34
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
35 Runs the ``samtools idxstats`` command. It retrieves and prints stats in the index file.
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
36
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
37 Input is a sorted and indexed BAM file, the output is tabular with
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
38 four columns (one row per reference sequence plus a final line for
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
39 unmapped reads)::
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
40
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
41 Column Description
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
42 ------ -----------------------------
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
43 1 Reference sequence identifier
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
44 2 Reference sequence length
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
45 3 Number of mapped reads
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
46 4 Number of placed but unmapped reads
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
47 (typically unmapped partners of mapped reads)
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
48
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
49 ------
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
50
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
51 **Example** output from a *de novo* assembly::
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
52
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
53 contig_1 170035 98397 0
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
54 contig_2 403835 199564 0
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
55 contig_3 553102 288189 0
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
56 ... ... ... ...
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
57 contig_603 653 50 0
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
58 contig_604 214 6 0
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
59 \* 0 0 50320
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
60
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
61 In this example there were 604 contigs, each with one line in the output table,
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
62 plus the final row (labelled with an asterisk) representing 50320 unmapped reads.
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
63 In this BAM file, the final column was otherwise zero.
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
64
5
fd87401a3da6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 558d30ff047fe2f62658e8b57e27ebe8db77ede1"
iuc
parents: 4
diff changeset
65
fd87401a3da6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 558d30ff047fe2f62658e8b57e27ebe8db77ede1"
iuc
parents: 4
diff changeset
66 The results of samtools ixdstats can be visualized with MultiQC.
fd87401a3da6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 558d30ff047fe2f62658e8b57e27ebe8db77ede1"
iuc
parents: 4
diff changeset
67
0
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
68 ------
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
69
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
70 Peter J.A. Cock (2013), `Galaxy wrapper <https://github.com/peterjc/pico_galaxy/tree/master/tools/samtools_idxstats>`_ for the samtools idxstats command
2
e726bb429392 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 0
diff changeset
71 ]]></help>
e726bb429392 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 0
diff changeset
72 <expand macro="citations"/>
0
a5f8ee692d38 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/samtools_idxstats commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
73 </tool>