annotate samtools_flagstat.xml @ 9:5fbe9dcaef98 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 558d30ff047fe2f62658e8b57e27ebe8db77ede1"
author iuc
date Fri, 06 Sep 2019 11:21:12 -0400
parents 5fd05c7b42f8
children 9b44224f5a76
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
5fbe9dcaef98 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 558d30ff047fe2f62658e8b57e27ebe8db77ede1"
iuc
parents: 8
diff changeset
1 <tool id="samtools_flagstat" name="Samtools flagstat" version="2.0.3">
6
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
2 <description>tabulate descriptive stats for BAM datset</description>
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
3
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
4 <macros>
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
5 <import>macros.xml</import>
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
6 </macros>
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
7 <expand macro="requirements"/>
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
8 <expand macro="stdio"/>
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
9 <expand macro="version_command"/>
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
10
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
11 <command><![CDATA[
8
5fd05c7b42f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit a972815cbd43dea553b3c0e4ad548f35d0023228-dirty
iuc
parents: 7
diff changeset
12 @ADDTHREADS@
5fd05c7b42f8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit a972815cbd43dea553b3c0e4ad548f35d0023228-dirty
iuc
parents: 7
diff changeset
13 samtools flagstat -@ \$addthreads '$input1' > '$output1'
6
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
14 ]]></command>
0
1bbde47ebd2a Uploaded
devteam
parents:
diff changeset
15
6
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
16 <inputs>
7
5d3100bf5357 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 70b38ebad0d0936f102e3e7cb70f1060347ea8c4
iuc
parents: 6
diff changeset
17 <param name="input1" type="data" format="sam,bam,cram" label="BAM File to report statistics of" />
6
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
18 </inputs>
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
19
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
20 <outputs>
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
21 <data name="output1" format="txt" />
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
22 </outputs>
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
23
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
24 <tests>
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
25 <test>
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
26 <param name="input1" value="samtools_flagstat_input1.bam" ftype="bam" />
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
27 <output name="output1" file="samtools_flagstat_out1.txt" />
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
28 </test>
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
29 </tests>
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
30 <help><![CDATA[
0
1bbde47ebd2a Uploaded
devteam
parents:
diff changeset
31 **What it does**
1bbde47ebd2a Uploaded
devteam
parents:
diff changeset
32
4
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
33 Uses ``samtools flagstat`` command to print descriptive information for a BAM dataset. Here is an example of such information::
0
1bbde47ebd2a Uploaded
devteam
parents:
diff changeset
34
6
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
35 200 + 0 in total (QC-passed reads + QC-failed reads)
4
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
36 0 + 0 secondary
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
37 0 + 0 supplementary
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
38 0 + 0 duplicates
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
39 25 + 0 mapped (12.50%:nan%)
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
40 200 + 0 paired in sequencing
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
41 100 + 0 read1
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
42 100 + 0 read2
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
43 0 + 0 properly paired (0.00%:nan%)
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
44 0 + 0 with itself and mate mapped
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
45 25 + 0 singletons (12.50%:nan%)
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
46 0 + 0 with mate mapped to a different chr
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
47 0 + 0 with mate mapped to a different chr (mapQ>=5)
9
5fbe9dcaef98 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 558d30ff047fe2f62658e8b57e27ebe8db77ede1"
iuc
parents: 8
diff changeset
48
5fbe9dcaef98 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 558d30ff047fe2f62658e8b57e27ebe8db77ede1"
iuc
parents: 8
diff changeset
49 The results of samtools flagstat can be visualized with MultiQC.
6
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
50 ]]></help>
28eb6a47be96 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 4
diff changeset
51 <expand macro="citations"/>
3
480404be9626 Uploaded version 1.0.3 for samtools 1.1
devteam
parents: 2
diff changeset
52 </tool>