annotate read_duplication.xml @ 10:c63fbdcc0dbe draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 57f71aa633a43ab02bbf05acd0c6d7f406e01f1e"
author iuc
date Thu, 28 Nov 2019 20:46:57 +0000
parents 71ed55a3515a
children d7f6b3653d84
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_duplication" name="Read Duplication" 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 reads duplication rate with sequence-based and mapping-based strategies</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_duplication.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_duplication.py -i '${input}' -o output -u ${upLimit} -q ${mapq}
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
16 ]]>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
17 </command>
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 <inputs>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
20 <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
21 <param name="upLimit" type="integer" label="Upper Limit of Plotted Duplicated Times (default=500)" value="500" help="(--up-limit)"/>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
22 <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
23 <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
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.DupRate_plot.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 format="xls" name="outputxls" from_work_dir="output.pos.DupRate.xls" label="${tool.name} on ${on_string} (Position xls)"/>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
29 <data format="xls" name="outputseqxls" from_work_dir="output.seq.DupRate.xls" label="${tool.name} on ${on_string} (Sequence xls)"/>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
30 <expand macro="rscript_output_data" filename="output.DupRate_plot.r" />
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
31 </outputs>
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
32
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
33 <tests>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
34 <test>
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="input" value="pairend_strandspecific_51mer_hg19_chr1_1-100000.bam" />
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="outputxls" file="output.pos.DupRate.xls" />
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="outputseqxls" file="output.seq.DupRate.xls" />
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="outputr" file="output.DupRate_plot.r" />
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="outputpdf" file="output.DupRate_plot.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
41 </test>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
42 </tests>
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
43
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
44 <help><![CDATA[
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
45 read_duplication.py
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
46 +++++++++++++++++++
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
47
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
48 Two strategies were used to determine reads duplication rate:
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
49
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
50 * Sequence based: reads with exactly the same sequence content are regarded as duplicated reads.
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
51 * Mapping based: reads mapped to the same genomic location are regarded as duplicated reads. For splice reads, reads mapped to the same starting position and splice the same way are regarded as duplicated reads.
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
52
f92b87abef3d just xmls
nilesh
parents:
diff changeset
53 Inputs
f92b87abef3d just xmls
nilesh
parents:
diff changeset
54 ++++++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
55
f92b87abef3d just xmls
nilesh
parents:
diff changeset
56 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
57 Alignment file in BAM/SAM format.
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
58
f92b87abef3d just xmls
nilesh
parents:
diff changeset
59 Upper Limit of Plotted Duplicated Times (default=500)
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
60 Only used for plotting.
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
61
f92b87abef3d just xmls
nilesh
parents:
diff changeset
62 Output
f92b87abef3d just xmls
nilesh
parents:
diff changeset
63 ++++++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
64
f92b87abef3d just xmls
nilesh
parents:
diff changeset
65 1. output.dup.pos.DupRate.xls: Read duplication rate determined from mapping position of read. First column is "occurrence" or duplication times, second column is number of uniquely mapped reads.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
66 2. output.dup.seq.DupRate.xls: Read duplication rate determined from sequence of read. First column is "occurrence" or duplication times, second column is number of uniquely mapped reads.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
67 3. output.DupRate_plot.r: R script to generate pdf file
f92b87abef3d just xmls
nilesh
parents:
diff changeset
68 4. output.DupRate_plot.pdf: graphical output generated from R script
f92b87abef3d just xmls
nilesh
parents:
diff changeset
69
3
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
70 .. image:: $PATH_TO_IMAGES/duplicate.png
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
71 :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
72 :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
73 :scale: 80 %
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 @ABOUT@
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 ]]>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
78 </help>
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
79
71ed55a3515a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 1
diff changeset
80 <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
81
1
f92b87abef3d just xmls
nilesh
parents:
diff changeset
82 </tool>