annotate samtools_flagstat.xml @ 18:dc66a024be19 draft default tip

Uploaded
author jbrayet
date Wed, 25 Nov 2015 03:42:45 -0500
parents 4b56f6feb248
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
1 <tool id="samtools_flagstat" name="Flagstat" version="2.0">
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
2 <description>tabulate descriptive stats for BAM datset</description>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
3 <macros>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
4 <import>macros.xml</import>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
5 </macros>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
6 <expand macro="requirements"></expand>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
7 <expand macro="stdio"></expand>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
8 <expand macro="version_command"></expand>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
9 <command>samtools flagstat "$input1" > "$output1"
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
10 </command>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
11 <inputs>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
12 <param name="input1" type="data" format="bam" label="BAM File to Convert" />
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
13 </inputs>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
14 <outputs>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
15 <data name="output1" format="txt" />
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
16 </outputs>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
17 <tests>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
18 <test>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
19 <param name="input1" value="samtools_flagstat_input1.bam" ftype="bam" />
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
20 <output name="output1" file="samtools_flagstat_out1.txt" />
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
21 </test>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
22 </tests>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
23 <help>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
24
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
25 **What it does**
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
26
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
27 Uses ``samtools flagstat`` command to print descriptive information for a BAM dataset. Here is an example of such information::
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
28
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
29 200 + 0 in total (QC-passed reads + QC-failed reads)
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
30 0 + 0 secondary
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
31 0 + 0 supplementary
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
32 0 + 0 duplicates
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
33 25 + 0 mapped (12.50%:nan%)
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
34 200 + 0 paired in sequencing
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
35 100 + 0 read1
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
36 100 + 0 read2
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
37 0 + 0 properly paired (0.00%:nan%)
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
38 0 + 0 with itself and mate mapped
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
39 25 + 0 singletons (12.50%:nan%)
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
40 0 + 0 with mate mapped to a different chr
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
41 0 + 0 with mate mapped to a different chr (mapQ>=5)
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
42
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
43 </help>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
44 <expand macro="citations"></expand>
4b56f6feb248 Uploaded
jbrayet
parents:
diff changeset
45 </tool>