annotate read_quality.xml @ 63:27e16a30667a draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
author iuc
date Tue, 09 Apr 2024 11:24:55 +0000
parents 5968573462fa
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
60
1421603cc95b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 1dfe55ca83685cadb0ce8f6ebbd8c13232376d1d
iuc
parents: 59
diff changeset
1 <tool id="rseqc_read_quality" name="Read Quality" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@GALAXY_VERSION@">
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
2 <description>determines Phred quality score</description>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
3 <macros>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
4 <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
5 </macros>
61
5968573462fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 8a91236cee4d408ae2b53a3e9b6daebc332d631a
iuc
parents: 60
diff changeset
6 <expand macro="bio_tools"/>
52
34e4c586e3c0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 7f68686cac77df831f1a26a2126a238a2e480316
iuc
parents: 51
diff changeset
7 <expand macro="requirements">
34e4c586e3c0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 7f68686cac77df831f1a26a2126a238a2e480316
iuc
parents: 51
diff changeset
8 <!--
34e4c586e3c0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 7f68686cac77df831f1a26a2126a238a2e480316
iuc
parents: 51
diff changeset
9 Required due to conda solver bug: https://github.com/conda/conda/issues/6269
34e4c586e3c0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 7f68686cac77df831f1a26a2126a238a2e480316
iuc
parents: 51
diff changeset
10 See: https://github.com/galaxyproject/tools-iuc/pull/1578 for more info
34e4c586e3c0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 7f68686cac77df831f1a26a2126a238a2e480316
iuc
parents: 51
diff changeset
11 -->
60
1421603cc95b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 1dfe55ca83685cadb0ce8f6ebbd8c13232376d1d
iuc
parents: 59
diff changeset
12 <requirement type="package" version="4.2.2">r-base</requirement>
52
34e4c586e3c0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 7f68686cac77df831f1a26a2126a238a2e480316
iuc
parents: 51
diff changeset
13 </expand>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
14 <expand macro="stdio"/>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
15 <version_command><![CDATA[read_quality.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
16 <command><![CDATA[
60
1421603cc95b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 1dfe55ca83685cadb0ce8f6ebbd8c13232376d1d
iuc
parents: 59
diff changeset
17 @BAM_SAM_INPUTS@
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
18 read_quality.py
60
1421603cc95b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 1dfe55ca83685cadb0ce8f6ebbd8c13232376d1d
iuc
parents: 59
diff changeset
19 --input-file 'input.${extension}'
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
20 --out-prefix output
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 50
diff changeset
21 -r ${reduce}
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 50
diff changeset
22 --mapq ${mapq}
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
23 ]]>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
24 </command>
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
25 <inputs>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
26 <expand macro="bam_sam_param"/>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
27 <param name="reduce" type="integer" label="Ignore Phred scores less than this amount (only applies to 'boxplot', default=1000)" value="1000" help="(--reduce)"/>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
28 <expand macro="mapq_param"/>
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
29 <expand macro="rscript_output_param"/>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
30 </inputs>
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
31 <outputs>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
32 <data format="pdf" name="outputheatpdf" from_work_dir="output.qual.heatmap.pdf" label="${tool.name} on ${on_string} (Heatmap pdf)"/>
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
33 <data format="pdf" name="outputboxpdf" from_work_dir="output.qual.boxplot.pdf" label="${tool.name} on ${on_string} (Boxplot pdf)"/>
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
34 <expand macro="rscript_output_data" filename="output.qual.r"/>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
35 </outputs>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
36 <tests>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
37 <test expect_num_outputs="3">
50
f242ee103277 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc commit 91ad241aa3f34b70649d13a5f18611da7577a5ee
lparsons
parents: 49
diff changeset
38 <param name="input" value="pairend_strandspecific_51mer_hg19_random.bam"/>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
39 <param name="rscript_output" value="true"/>
59
dbedfc5f5a3c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 247059e2527b66f1dbecf1e61496daef921040c3"
iuc
parents: 52
diff changeset
40 <output name="outputr" file="output.qual_r"/>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
41 <output name="outputheatpdf" file="output.qual.heatmap.pdf" compare="sim_size"/>
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
42 <output name="outputboxpdf" file="output.qual.boxplot.pdf" compare="sim_size"/>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
43 </test>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
44 </tests>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
45 <help><![CDATA[
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
46 read_quality.py
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
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
49 According to SAM specification, if Q is the character to represent "base calling quality"
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
50 in SAM file, then Phred Quality Score = ord(Q) - 33. Here ord() is python function that
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
51 returns an integer representing the Unicode code point of the character when the argument
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
52 is a unicode object, for example, ord('a') returns 97. Phred quality score is widely used
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
53 to measure "reliability" of base-calling, for example, phred quality score of 20 means
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
54 there is 1/100 chance that the base-calling is wrong, phred quality score of 30 means there
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
55 is 1/1000 chance that the base-calling is wrong. In general: Phred quality score = -10xlog(10)P,
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
56 here P is probability that base-calling is wrong.
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
57
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
58 Inputs
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
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
61 Input BAM/SAM file
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
62 Alignment file in BAM/SAM format.
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
63
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
64 Ignore phred scores less than this number (default=1000)
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
65 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'.
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
66
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
67 Output
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
68 ++++++++++++++
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
69
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
70 1. output.qual.r
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
71 2. output.qual.boxplot.pdf
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 50
diff changeset
72 .. image:: $PATH_TO_IMAGES/36mer.qual.plot.png
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
73 :height: 600 px
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
74 :width: 600 px
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
75 :scale: 80 %
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
76 3. output.qual.heatmap.pdf
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 50
diff changeset
77 .. image:: $PATH_TO_IMAGES/36mer.qual.heatmap.png
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
78 :height: 600 px
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
79 :width: 600 px
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
80 :scale: 80 %
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
81
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
82 Heatmap: use different color to represent nucleotide density ("blue"=low density,"orange"=median density,"red"=high density")
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
83
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 50
diff changeset
84 @ABOUT@
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
85
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
86 ]]>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
87 </help>
63
27e16a30667a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit d7544582d5599c67a284faf9232cd2ccc4daa1de
iuc
parents: 61
diff changeset
88 <expand macro="citations"/>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
89 </tool>