annotate bam_stat.xml @ 1:cd2daa987b69 draft default tip

planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit 2400cce6e3918648fda8f2a8d8485ab251a58827
author lparsons
date Tue, 07 Jul 2015 14:14:04 -0400
parents 306127635959
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
1 <tool id="rseqc_bam_stat" name="BAM/SAM Mapping Stats" version="2.4galaxy1">
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
2 <description>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
3 reads mapping statistics for a provided BAM or SAM file.
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
4 </description>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
5
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
6 <macros>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
7 <import>rseqc_macros.xml</import>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
8 </macros>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
9
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
10 <requirements>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
11 <expand macro="requirement_package_numpy" />
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
12 <expand macro="requirement_package_rseqc" />
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
13 </requirements>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
14
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
15 <expand macro="stdio" />
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
16
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
17 <version_command><![CDATA[bam_stat.py --version]]></version_command>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
18
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
19 <command><![CDATA[
1
cd2daa987b69 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit 2400cce6e3918648fda8f2a8d8485ab251a58827
lparsons
parents: 0
diff changeset
20 bam_stat.py -i $input -q $mapq 2> $output
0
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
21 ]]>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
22 </command>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
23
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
24 <inputs>
1
cd2daa987b69 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit 2400cce6e3918648fda8f2a8d8485ab251a58827
lparsons
parents: 0
diff changeset
25 <param name="input" type="data" label="Input .bam File" format="bam" help="(--input-file)"/>
cd2daa987b69 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit 2400cce6e3918648fda8f2a8d8485ab251a58827
lparsons
parents: 0
diff changeset
26 <param name="mapq" value="30" type="integer" label="Minimum mapping quality for an alignment to be called 'uniquly mapped'" help="(--mapq)" />
0
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
27 </inputs>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
28
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
29 <outputs>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
30 <data format="txt" name="output" />
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
31 </outputs>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
32
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
33 <tests>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
34 <test>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
35 <param name="input" value="pairend_strandspecific_51mer_hg19_chr1_1-100000.bam"/>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
36 <output name="output" file="bamstats.txt"/>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
37 </test>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
38 </tests>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
39
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
40 <help><![CDATA[
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
41 bam_stat.py
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
42 +++++++++++
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
43
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
44 This program is used to calculate reads mapping statistics from provided BAM
1
cd2daa987b69 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit 2400cce6e3918648fda8f2a8d8485ab251a58827
lparsons
parents: 0
diff changeset
45 file. This script determines "uniquely mapped reads" from `mapping quality
cd2daa987b69 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit 2400cce6e3918648fda8f2a8d8485ab251a58827
lparsons
parents: 0
diff changeset
46 <http://genome.sph.umich.edu/wiki/Mapping_Quality_Scores>`_,
0
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
47 which quality the probability that a read is misplaced (Do NOT confused with
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
48 sequence quality, sequence quality measures the probability that a base-calling
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
49 was wrong) .
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
50
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
51 Inputs
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
52 ++++++++++++++
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
53
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
54 Input BAM/SAM file
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
55 Alignment file in BAM/SAM format.
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
56
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
57 Minimum mapping quality
1
cd2daa987b69 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit 2400cce6e3918648fda8f2a8d8485ab251a58827
lparsons
parents: 0
diff changeset
58 Minimum mapping quality for an alignment to be called "uniquely mapped" (default=30)
0
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
59
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
60 Output
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
61 ++++++++++++++
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
62
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
63 - Total Reads (Total records) = {Multiple mapped reads} + {Uniquely mapped}
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
64 - Uniquely mapped Reads = {read-1} + {read-2} (if paired end)
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
65 - Uniquely mapped Reads = {Reads map to '+'} + {Reads map to '-'}
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
66 - Uniquely mapped Reads = {Splice reads} + {Non-splice reads}
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
67
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
68 -----
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
69
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
70 About RSeQC
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
71 +++++++++++
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
72
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
73
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
74 The RSeQC_ package provides a number of useful modules that can comprehensively evaluate high throughput sequence data especially RNA-seq data. "Basic modules" quickly inspect sequence quality, nucleotide composition bias, PCR bias and GC bias, while "RNA-seq specific modules" investigate sequencing saturation status of both splicing junction detection and expression estimation, mapped reads clipping profile, mapped reads distribution, coverage uniformity over gene body, reproducibility, strand specificity and splice junction annotation.
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
75
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
76 The RSeQC package is licensed under the GNU GPL v3 license.
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
77
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
78 .. image:: http://rseqc.sourceforge.net/_static/logo.png
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
79
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
80 .. _RSeQC: http://rseqc.sourceforge.net/
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
81
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
82 ]]>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
83 </help>
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
84
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
85 <expand macro="citations" />
306127635959 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit aeb25d807817746dd6957f30ce2070662cc10e91
lparsons
parents:
diff changeset
86 </tool>