annotate geneBody_coverage2.xml @ 11:d7f6b3653d84 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
author iuc
date Wed, 01 Sep 2021 08:21:45 +0000
parents 4ad8715dc2bf
children 57fad5deeb8e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
4ad8715dc2bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 62d3a29f93f3f6cb3ba9683fde5ff0606b90700d
iuc
parents: 6
diff changeset
1 <tool id="rseqc_geneBody_coverage2" name="Gene Body Coverage (Bigwig)" version="@WRAPPER_VERSION@.1">
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
2 <description>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
3 Read coverage over gene body
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
4 </description>
11
d7f6b3653d84 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 8
diff changeset
5 <expand macro="bio_tools"/>
3
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 <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
8 </macros>
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="requirements" />
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 <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
13
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
14 <version_command><![CDATA[geneBody_coverage2.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
15
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
16 <command><![CDATA[
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
17 geneBody_coverage2.py -i '${input}' -r '${refgene}' -o output
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
18 ]]>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
19 </command>
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 <inputs>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
22 <param name="input" type="data" label="Input bigwig file" format="bigwig" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
23 <expand macro="refgene_param" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
24 </inputs>
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
25
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
26 <outputs>
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="pdf_output_data" filename="output.geneBodyCoverage.pdf" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
28 <data name="outputtxt" format="txt" from_work_dir="output.geneBodyCoverage.txt" label="${tool.name} on ${on_string} (text)" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
29 <expand macro="rscript_output_data" filename="output.geneBodyCoverage_plot.r" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
30 </outputs>
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
31
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
32 <tests>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
33 <test>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
34 <param name="input" value="pairend_strandspecific_51mer_hg19_chr1_1-100000.bigwig" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
35 <param name="refgene" value="hg19_RefSeq_chr1_1-100000.bed" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
36 <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
37 <output name="outputpdf" file="output.geneBodyCoverage2.curves.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
38 <output name="outputr" file="output.geneBodyCoverage2.r" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
39 <output name="outputtxt" file="output.geneBodyCoverage2.txt" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
40 </test>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
41 </tests>
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
42
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
43 <help><![CDATA[
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
44 geneBody_coverage2.py
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
45 +++++++++++++++++++++
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
46
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
47 Similar to geneBody_coverage.py. This module takes bigwig instead of BAM as input, and thus
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
48 requires much less memory. The BigWig file could be arbitrarily large.
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
49
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
50
f92b87abef3d just xmls
nilesh
parents:
diff changeset
51 Inputs
f92b87abef3d just xmls
nilesh
parents:
diff changeset
52 ++++++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
53
f92b87abef3d just xmls
nilesh
parents:
diff changeset
54 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
55 Alignment file in BAM/SAM format.
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
56
f92b87abef3d just xmls
nilesh
parents:
diff changeset
57 Reference gene model
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
58 Gene Model in BED format.
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
59
f92b87abef3d just xmls
nilesh
parents:
diff changeset
60
f92b87abef3d just xmls
nilesh
parents:
diff changeset
61 Outputs
f92b87abef3d just xmls
nilesh
parents:
diff changeset
62 ++++++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
63
f92b87abef3d just xmls
nilesh
parents:
diff changeset
64 Read coverage over gene body. This module is used to check if reads coverage is uniform and if there is any 5’/3’ bias. This module scales all transcripts to 100 nt and calculates the number of reads covering each nucleotide position. Finally, it generates a plot illustrating the coverage profile along the gene body. NOTE: this module requires lots of memory for large BAM files, because it load the entire BAM file into memory. We add another script "geneBody_coverage2.py" into v2.3.1 which takes bigwig (instead of BAM) as input. It only use 200M RAM, but users need to convert BAM into WIG, and then WIG into BigWig.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
65
f92b87abef3d just xmls
nilesh
parents:
diff changeset
66 Example output:
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
67 .. image:: $PATH_TO_IMAGES/geneBody_coverage.png
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
68 :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
69 :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
70 :scale: 80 %
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
71
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
72 @ABOUT@
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
73
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
74 ]]>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
75 </help>
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
76
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
77 <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
78
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
79 </tool>