Mercurial > repos > devteam > samtools_flagstat

annotate samtools_flagstat.xml @ 10:9b44224f5a76 draft default tip

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_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
author iuc
date Tue, 28 Sep 2021 16:02:06 +0000
parents 5fbe9dcaef98
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
1 <tool id="samtools_flagstat" name="Samtools flagstat" version="2.0.4" profile="@PROFILE@">
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@
10
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
13 samtools flagstat -@ \$addthreads
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
14 #if $output_fmt != 'txt'
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
15 --output-fmt $output_fmt
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
16 #end if
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
17 '$input1'
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
18 > '$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
19 ]]></command>
0
1bbde47ebd2a Uploaded
devteam
parents:
diff changeset
20
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
21 <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
22 <param name="input1" type="data" format="sam,bam,cram" label="BAM File to report statistics of" />
10
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
23 <param argument="--output-fmt" type="select" label="Output format">
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
24 <option value="txt">txt</option>
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
25 <option value="tsv">tsv</option>
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
26 <option value="json">json</option>
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
27 </param>
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
28 </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
29
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 <outputs>
10
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
31 <data name="output1" format="txt">
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
32 <change_format>
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
33 <when input="output_fmt" value="tsv" format="tabular" />
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
34 <when input="output_fmt" value="json" format="json" />
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
35 </change_format>
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
36 </data>
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
37 </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
38
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
39 <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
40 <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
41 <param name="input1" value="samtools_flagstat_input1.bam" ftype="bam" />
10
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
42 <output name="output1" file="samtools_flagstat_out1.txt" ftype="txt"/>
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
43 </test>
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
44 <test>
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
45 <param name="input1" value="samtools_flagstat_input1.bam" ftype="bam" />
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
46 <param name="output_fmt" value="tsv"/>
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
47 <output name="output1" file="samtools_flagstat_out1.tsv" ftype="tabular" />
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
48 </test>
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
49 <test>
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
50 <param name="input1" value="samtools_flagstat_input1.bam" ftype="bam" />
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
51 <param name="output_fmt" value="json"/>
9b44224f5a76 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_flagstat commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 9
diff changeset
52 <output name="output1" file="samtools_flagstat_out1.json" ftype="json" />
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
53 </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
54 </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
55 <help><![CDATA[
0
1bbde47ebd2a Uploaded
devteam
parents:
diff changeset
56 **What it does**
1bbde47ebd2a Uploaded
devteam
parents:
diff changeset
57
4
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
58 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
59
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
60 200 + 0 in total (QC-passed reads + QC-failed reads)
4
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
61 0 + 0 secondary
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
62 0 + 0 supplementary
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
63 0 + 0 duplicates
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
64 25 + 0 mapped (12.50%:nan%)
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
65 200 + 0 paired in sequencing
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
66 100 + 0 read1
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
67 100 + 0 read2
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
68 0 + 0 properly paired (0.00%:nan%)
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
69 0 + 0 with itself and mate mapped
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
70 25 + 0 singletons (12.50%:nan%)
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
71 0 + 0 with mate mapped to a different chr
10b658bef71a planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 3
diff changeset
72 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
73
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
74 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
75 ]]></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
76 <expand macro="citations"/>
3
480404be9626 Uploaded version 1.0.3 for samtools 1.1
devteam
parents: 2
diff changeset
77 </tool>