annotate read_quality.xml @ 3:71ed55a3515a 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:22:57 -0400
parents f92b87abef3d
children caaa120457bc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
1 <tool id="rseqc_read_quality" name="Read Quality" version="@WRAPPER_VERSION@">
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
2 <description>determines Phred quality score</description>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
4 <macros>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
5 <import>rseqc_macros.xml</import>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
6 </macros>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
7
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
8 <expand macro="requirements" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
9
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
10 <expand macro="stdio" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
11
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
12 <version_command><![CDATA[read_quality.py --version]]></version_command>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
13
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
14 <command><![CDATA[
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
15 read_quality.py
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
16 --input-file '${input}'
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
17 --out-prefix output
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
18 -r ${reduce}
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
19 --mapq ${mapq}
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
20 ]]>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
21 </command>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
22
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
23 <inputs>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
24 <expand macro="bam_sam_param" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
25 <param name="reduce" type="integer" label="Ignore Phred scores less than this amount (only applies to 'boxplot', default=1000)" value="1000" help="(--reduce)"/>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
26 <expand macro="mapq_param" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
27 <expand macro="rscript_output_param" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
28 </inputs>
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
29
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
30 <outputs>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
31 <data format="pdf" name="outputheatpdf" from_work_dir="output.qual.heatmap.pdf" label="${tool.name} on ${on_string} (Heatmap pdf)" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
32 <data format="pdf" name="outputboxpdf" from_work_dir="output.qual.boxplot.pdf" label="${tool.name} on ${on_string} (Boxplot pdf)" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
33 <expand macro="rscript_output_data" filename="output.qual.r" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
34 </outputs>
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
35
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
36 <tests>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
37 <test>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
38 <param name="input" value="pairend_strandspecific_51mer_hg19_random.bam"/>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
39 <param name="rscript_output" value="true" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
40 <output name="outputr" file="output.qual.r"/>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
41 <output name="outputheatpdf" file="output.qual.heatmap.pdf" compare="sim_size" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
42 <output name="outputboxpdf" file="output.qual.boxplot.pdf" compare="sim_size" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
43 </test>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
44 </tests>
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
45
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
46 <help><![CDATA[
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
47 read_quality.py
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
48 +++++++++++++++
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
49
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
50 According to SAM specification, if Q is the character to represent "base calling quality"
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
51 in SAM file, then Phred Quality Score = ord(Q) - 33. Here ord() is python function that
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
52 returns an integer representing the Unicode code point of the character when the argument
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
53 is a unicode object, for example, ord('a') returns 97. Phred quality score is widely used
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
54 to measure "reliability" of base-calling, for example, phred quality score of 20 means
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
55 there is 1/100 chance that the base-calling is wrong, phred quality score of 30 means there
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
56 is 1/1000 chance that the base-calling is wrong. In general: Phred quality score = -10xlog(10)P,
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
57 here P is probability that base-calling is wrong.
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
58
f92b87abef3d just xmls
nilesh
parents:
diff changeset
59 Inputs
f92b87abef3d just xmls
nilesh
parents:
diff changeset
60 ++++++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
61
f92b87abef3d just xmls
nilesh
parents:
diff changeset
62 Input BAM/SAM file
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
63 Alignment file in BAM/SAM format.
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
64
f92b87abef3d just xmls
nilesh
parents:
diff changeset
65 Ignore phred scores less than this number (default=1000)
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
66 To avoid making huge vector in R, nucleotide with certain phred score represented less than this number will be ignored. Increase this number save more memory while reduce precision. This option only applies to the 'boxplot'.
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
67
f92b87abef3d just xmls
nilesh
parents:
diff changeset
68 Output
f92b87abef3d just xmls
nilesh
parents:
diff changeset
69 ++++++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
70
f92b87abef3d just xmls
nilesh
parents:
diff changeset
71 1. output.qual.r
f92b87abef3d just xmls
nilesh
parents:
diff changeset
72 2. output.qual.boxplot.pdf
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
73 .. image:: $PATH_TO_IMAGES/36mer.qual.plot.png
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
74 :height: 600 px
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
75 :width: 600 px
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
76 :scale: 80 %
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
77 3. output.qual.heatmap.pdf
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
78 .. image:: $PATH_TO_IMAGES/36mer.qual.heatmap.png
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
79 :height: 600 px
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
80 :width: 600 px
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
81 :scale: 80 %
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
82
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
83 Heatmap: use different color to represent nucleotide density ("blue"=low density,"orange"=median density,"red"=high density")
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
84
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
85 @ABOUT@
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
86
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
87 ]]>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
88 </help>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
89
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
90 <expand macro="citations" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
91
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
92 </tool>