Mercurial > repos > devteam > samtools_idxstats

annotate samtools_idxstats.xml @ 4:7a6034296ae9 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 558d30ff047fe2f62658e8b57e27ebe8db77ede1"
author iuc
date Fri, 06 Sep 2019 11:22:45 -0400
parents 811fc2d75ad4
children 7def34e6cf4d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
7a6034296ae9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 558d30ff047fe2f62658e8b57e27ebe8db77ede1"
iuc
parents: 3
diff changeset
1 <tool id="samtools_idxstats" name="Samtools idxstats" version="2.0.3">
1
88b8c2916784 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
87398ae795c7 Uploaded
devteam
parents:
diff changeset
3 <macros>
1
88b8c2916784 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
87398ae795c7 Uploaded
devteam
parents:
diff changeset
5 </macros>
1
88b8c2916784 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"/>
88b8c2916784 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"/>
88b8c2916784 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
87398ae795c7 Uploaded
devteam
parents:
diff changeset
9 <command><![CDATA[
3
811fc2d75ad4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit ca0d1d44099fd21e0f8214102f4d8a2fd2d054d6
iuc
parents: 2
diff changeset
10 @ADDTHREADS@
811fc2d75ad4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit ca0d1d44099fd21e0f8214102f4d8a2fd2d054d6
iuc
parents: 2
diff changeset
11 @PREPARE_IDX@
811fc2d75ad4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit ca0d1d44099fd21e0f8214102f4d8a2fd2d054d6
iuc
parents: 2
diff changeset
12 samtools idxstats -@ \$addthreads infile > '${output}'
1
88b8c2916784 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
87398ae795c7 Uploaded
devteam
parents:
diff changeset
14 <inputs>
2
04d5581db1f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 70b38ebad0d0936f102e3e7cb70f1060347ea8c4
iuc
parents: 1
diff changeset
15 <param name="input" type="data" format="bam,cram" label="BAM file" />
0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
16 </inputs>
87398ae795c7 Uploaded
devteam
parents:
diff changeset
17 <outputs>
87398ae795c7 Uploaded
devteam
parents:
diff changeset
18 <data format="tabular" name="output" label="${tool.name} on ${on_string}" />
87398ae795c7 Uploaded
devteam
parents:
diff changeset
19 </outputs>
87398ae795c7 Uploaded
devteam
parents:
diff changeset
20 <tests>
2
04d5581db1f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 70b38ebad0d0936f102e3e7cb70f1060347ea8c4
iuc
parents: 1
diff changeset
21 <!-- test from https://github.com/samtools/samtools/blob/9ce8c64493f7ea3fa69bc5c1ac980b1a8e3dcf1f/test/test.pl#L2556 -->
0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
22 <test>
2
04d5581db1f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 70b38ebad0d0936f102e3e7cb70f1060347ea8c4
iuc
parents: 1
diff changeset
23 <param name="input" value="test_input_1_a.bam" ftype="bam" />
04d5581db1f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 70b38ebad0d0936f102e3e7cb70f1060347ea8c4
iuc
parents: 1
diff changeset
24 <output name="output" file="test_input_1_a.bam.expected" compare="diff" ftype="tabular" />
04d5581db1f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 70b38ebad0d0936f102e3e7cb70f1060347ea8c4
iuc
parents: 1
diff changeset
25 </test>
04d5581db1f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 70b38ebad0d0936f102e3e7cb70f1060347ea8c4
iuc
parents: 1
diff changeset
26 <!-- test from original tool -->
04d5581db1f5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 70b38ebad0d0936f102e3e7cb70f1060347ea8c4
iuc
parents: 1
diff changeset
27 <test>
0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
28 <param name="input" value="phiX.bam" ftype="bam" />
87398ae795c7 Uploaded
devteam
parents:
diff changeset
29 <output name="output" file="samtools_idxstats_out.tabular" compare="diff" ftype="tabular" />
87398ae795c7 Uploaded
devteam
parents:
diff changeset
30 </test>
87398ae795c7 Uploaded
devteam
parents:
diff changeset
31 </tests>
1
88b8c2916784 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
87398ae795c7 Uploaded
devteam
parents:
diff changeset
33 **What it does**
87398ae795c7 Uploaded
devteam
parents:
diff changeset
34
87398ae795c7 Uploaded
devteam
parents:
diff changeset
35 Runs the ``samtools idxstats`` command. It retrieves and prints stats in the index file.
87398ae795c7 Uploaded
devteam
parents:
diff changeset
36
87398ae795c7 Uploaded
devteam
parents:
diff changeset
37 Input is a sorted and indexed BAM file, the output is tabular with
87398ae795c7 Uploaded
devteam
parents:
diff changeset
38 four columns (one row per reference sequence plus a final line for
87398ae795c7 Uploaded
devteam
parents:
diff changeset
39 unmapped reads)::
87398ae795c7 Uploaded
devteam
parents:
diff changeset
40
87398ae795c7 Uploaded
devteam
parents:
diff changeset
41 Column Description
87398ae795c7 Uploaded
devteam
parents:
diff changeset
42 ------ -----------------------------
87398ae795c7 Uploaded
devteam
parents:
diff changeset
43 1 Reference sequence identifier
87398ae795c7 Uploaded
devteam
parents:
diff changeset
44 2 Reference sequence length
87398ae795c7 Uploaded
devteam
parents:
diff changeset
45 3 Number of mapped reads
87398ae795c7 Uploaded
devteam
parents:
diff changeset
46 4 Number of placed but unmapped reads
87398ae795c7 Uploaded
devteam
parents:
diff changeset
47 (typically unmapped partners of mapped reads)
87398ae795c7 Uploaded
devteam
parents:
diff changeset
48
87398ae795c7 Uploaded
devteam
parents:
diff changeset
49 ------
87398ae795c7 Uploaded
devteam
parents:
diff changeset
50
87398ae795c7 Uploaded
devteam
parents:
diff changeset
51 **Example** output from a *de novo* assembly::
87398ae795c7 Uploaded
devteam
parents:
diff changeset
52
87398ae795c7 Uploaded
devteam
parents:
diff changeset
53 contig_1 170035 98397 0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
54 contig_2 403835 199564 0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
55 contig_3 553102 288189 0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
56 ... ... ... ...
87398ae795c7 Uploaded
devteam
parents:
diff changeset
57 contig_603 653 50 0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
58 contig_604 214 6 0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
59 \* 0 0 50320
87398ae795c7 Uploaded
devteam
parents:
diff changeset
60
87398ae795c7 Uploaded
devteam
parents:
diff changeset
61 In this example there were 604 contigs, each with one line in the output table,
87398ae795c7 Uploaded
devteam
parents:
diff changeset
62 plus the final row (labelled with an asterisk) representing 50320 unmapped reads.
87398ae795c7 Uploaded
devteam
parents:
diff changeset
63 In this BAM file, the final column was otherwise zero.
87398ae795c7 Uploaded
devteam
parents:
diff changeset
64
4
7a6034296ae9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 558d30ff047fe2f62658e8b57e27ebe8db77ede1"
iuc
parents: 3
diff changeset
65
7a6034296ae9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 558d30ff047fe2f62658e8b57e27ebe8db77ede1"
iuc
parents: 3
diff changeset
66 The results of samtools ixdstats can be visualized with MultiQC.
7a6034296ae9 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_idxstats commit 558d30ff047fe2f62658e8b57e27ebe8db77ede1"
iuc
parents: 3
diff changeset
67
0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
68 ------
87398ae795c7 Uploaded
devteam
parents:
diff changeset
69
87398ae795c7 Uploaded
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
1
88b8c2916784 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>
88b8c2916784 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
87398ae795c7 Uploaded
devteam
parents:
diff changeset
73 </tool>