annotate bam_stat.xml @ 51:09846d5169fa draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
author iuc
date Tue, 14 Mar 2017 10:23:21 -0400
parents 6b33e31bda10
children dbedfc5f5a3c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
1 <tool id="rseqc_bam_stat" name="BAM/SAM Mapping Stats" version="@WRAPPER_VERSION@">
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
2 <description>
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
3 reads mapping statistics for a provided BAM or SAM file.
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
4 </description>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
5
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
6 <macros>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
7 <import>rseqc_macros.xml</import>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
8 </macros>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
9
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
10 <expand macro="requirements" />
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
11
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
12 <expand macro="stdio" />
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
13
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
14 <version_command><![CDATA[bam_stat.py --version]]></version_command>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
15
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
16 <command><![CDATA[
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
17 bam_stat.py -i '${input}' -q ${mapq} > '${output}'
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
18 ]]>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
19 </command>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
20
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
21 <inputs>
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
22 <expand macro="bam_param" />
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
23 <expand macro="mapq_param" />
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
24 </inputs>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
25
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
26 <outputs>
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
27 <data format="txt" name="output" />
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
28 </outputs>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
29
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
30 <tests>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
31 <test>
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
32 <param name="input" value="pairend_strandspecific_51mer_hg19_chr1_1-100000.bam" />
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
33 <output name="output" file="output.bamstats.txt" />
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
34 </test>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
35 </tests>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
36
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
37 <help><![CDATA[
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
38 bam_stat.py
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
39 +++++++++++
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
40
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
41 This program is used to calculate reads mapping statistics from provided BAM
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
42 file. This script determines "uniquely mapped reads" from `mapping quality
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
43 <http://genome.sph.umich.edu/wiki/Mapping_Quality_Scores>`_,
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
44 which quality the probability that a read is misplaced (Do NOT confused with
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
45 sequence quality, sequence quality measures the probability that a base-calling
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
46 was wrong) .
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
47
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
48 Inputs
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
49 ++++++++++++++
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
50
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
51 Input BAM/SAM file
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
52 Alignment file in BAM/SAM format.
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
53
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
54 Minimum mapping quality
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
55 Minimum mapping quality for an alignment to be called "uniquely mapped" (default=30)
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
56
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
57 Output
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
58 ++++++++++++++
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
59
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
60 - Total Reads (Total records) = {Multiple mapped reads} + {Uniquely mapped}
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
61 - Uniquely mapped Reads = {read-1} + {read-2} (if paired end)
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
62 - Uniquely mapped Reads = {Reads map to '+'} + {Reads map to '-'}
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
63 - Uniquely mapped Reads = {Splice reads} + {Non-splice reads}
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
64
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
65 @ABOUT@
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
66
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
67 ]]>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
68 </help>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
69
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
70 <expand macro="citations" />
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
71 </tool>