Mercurial > repos > devteam > samtools_idxstats

annotate samtools_idxstats.xml @ 2:04d5581db1f5 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 70b38ebad0d0936f102e3e7cb70f1060347ea8c4
author iuc
date Thu, 27 Sep 2018 09:03:08 -0400
parents 88b8c2916784
children 811fc2d75ad4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
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
1 <tool id="samtools_idxstats" name="Samtools idxstats" version="2.0.2">
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[
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
10 @PREPARE_IDX@
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
11 samtools idxstats 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
12 ]]></command>
0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
13 <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
14 <param name="input" type="data" format="bam,cram" label="BAM file" />
0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
15 </inputs>
87398ae795c7 Uploaded
devteam
parents:
diff changeset
16 <outputs>
87398ae795c7 Uploaded
devteam
parents:
diff changeset
17 <data format="tabular" name="output" label="${tool.name} on ${on_string}" />
87398ae795c7 Uploaded
devteam
parents:
diff changeset
18 </outputs>
87398ae795c7 Uploaded
devteam
parents:
diff changeset
19 <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
20 <!-- test from https://github.com/samtools/samtools/blob/9ce8c64493f7ea3fa69bc5c1ac980b1a8e3dcf1f/test/test.pl#L2556 -->
0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
21 <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
22 <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
23 <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
24 </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
25 <!-- 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
26 <test>
0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
27 <param name="input" value="phiX.bam" ftype="bam" />
87398ae795c7 Uploaded
devteam
parents:
diff changeset
28 <output name="output" file="samtools_idxstats_out.tabular" compare="diff" ftype="tabular" />
87398ae795c7 Uploaded
devteam
parents:
diff changeset
29 </test>
87398ae795c7 Uploaded
devteam
parents:
diff changeset
30 </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
31 <help><![CDATA[
0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
32 **What it does**
87398ae795c7 Uploaded
devteam
parents:
diff changeset
33
87398ae795c7 Uploaded
devteam
parents:
diff changeset
34 Runs the ``samtools idxstats`` command. It retrieves and prints stats in the index file.
87398ae795c7 Uploaded
devteam
parents:
diff changeset
35
87398ae795c7 Uploaded
devteam
parents:
diff changeset
36 Input is a sorted and indexed BAM file, the output is tabular with
87398ae795c7 Uploaded
devteam
parents:
diff changeset
37 four columns (one row per reference sequence plus a final line for
87398ae795c7 Uploaded
devteam
parents:
diff changeset
38 unmapped reads)::
87398ae795c7 Uploaded
devteam
parents:
diff changeset
39
87398ae795c7 Uploaded
devteam
parents:
diff changeset
40 Column Description
87398ae795c7 Uploaded
devteam
parents:
diff changeset
41 ------ -----------------------------
87398ae795c7 Uploaded
devteam
parents:
diff changeset
42 1 Reference sequence identifier
87398ae795c7 Uploaded
devteam
parents:
diff changeset
43 2 Reference sequence length
87398ae795c7 Uploaded
devteam
parents:
diff changeset
44 3 Number of mapped reads
87398ae795c7 Uploaded
devteam
parents:
diff changeset
45 4 Number of placed but unmapped reads
87398ae795c7 Uploaded
devteam
parents:
diff changeset
46 (typically unmapped partners of mapped reads)
87398ae795c7 Uploaded
devteam
parents:
diff changeset
47
87398ae795c7 Uploaded
devteam
parents:
diff changeset
48 ------
87398ae795c7 Uploaded
devteam
parents:
diff changeset
49
87398ae795c7 Uploaded
devteam
parents:
diff changeset
50 **Example** output from a *de novo* assembly::
87398ae795c7 Uploaded
devteam
parents:
diff changeset
51
87398ae795c7 Uploaded
devteam
parents:
diff changeset
52 contig_1 170035 98397 0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
53 contig_2 403835 199564 0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
54 contig_3 553102 288189 0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
55 ... ... ... ...
87398ae795c7 Uploaded
devteam
parents:
diff changeset
56 contig_603 653 50 0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
57 contig_604 214 6 0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
58 \* 0 0 50320
87398ae795c7 Uploaded
devteam
parents:
diff changeset
59
87398ae795c7 Uploaded
devteam
parents:
diff changeset
60 In this example there were 604 contigs, each with one line in the output table,
87398ae795c7 Uploaded
devteam
parents:
diff changeset
61 plus the final row (labelled with an asterisk) representing 50320 unmapped reads.
87398ae795c7 Uploaded
devteam
parents:
diff changeset
62 In this BAM file, the final column was otherwise zero.
87398ae795c7 Uploaded
devteam
parents:
diff changeset
63
87398ae795c7 Uploaded
devteam
parents:
diff changeset
64 ------
87398ae795c7 Uploaded
devteam
parents:
diff changeset
65
87398ae795c7 Uploaded
devteam
parents:
diff changeset
66 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
67 ]]></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
68 <expand macro="citations"/>
0
87398ae795c7 Uploaded
devteam
parents:
diff changeset
69 </tool>