annotate inner_distance.xml @ 59:dbedfc5f5a3c draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 247059e2527b66f1dbecf1e61496daef921040c3"
author iuc
date Sat, 18 Dec 2021 19:41:19 +0000
parents f437057e46f1
children 1421603cc95b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
59
dbedfc5f5a3c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 247059e2527b66f1dbecf1e61496daef921040c3"
iuc
parents: 57
diff changeset
1 <tool id="rseqc_inner_distance" name="Inner Distance" version="@TOOL_VERSION@.1">
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
2 <description>calculate the inner distance (or insert size) between two paired RNA reads</description>
59
dbedfc5f5a3c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 247059e2527b66f1dbecf1e61496daef921040c3"
iuc
parents: 57
diff changeset
3 <expand macro="bio_tools"/>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
4 <macros>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
5 <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
6 </macros>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
7
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
8 <expand macro="requirements" />
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
9
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
10 <expand macro="stdio" />
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
11
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
12 <version_command><![CDATA[inner_distance.py --version]]></version_command>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
13
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
14 <command><![CDATA[
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
15 inner_distance.py -i '${input}' -o output -r '${refgene}'
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
16 --sample-size ${sample_size}
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
17 --lower-bound ${lowerBound}
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
18 --upper-bound ${upperBound}
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
19 --step ${step}
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
20 --mapq ${mapq}
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
21 ]]>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
22 </command>
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 <inputs>
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
25 <expand macro="bam_sam_param" />
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
26 <expand macro="refgene_param" />
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
27 <expand macro="sample_size_param" />
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
28 <param name="lowerBound" type="integer" value="-250" label="Lower bound (bp, default=-250)" help="Used for plotting histogram (--lower-bound)"/>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
29 <param name="upperBound" type="integer" value="250" label="Upper bound (bp, default=250)" help="Used for plotting histogram (--upper-bound)"/>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
30 <param name="step" type="integer" value="5" label="Step size of histogram (bp, default=5)" help="(--step)"/>
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
31 <expand macro="mapq_param" />
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
32 <expand macro="rscript_output_param" />
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
33 </inputs>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
34
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
35 <outputs>
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
36 <expand macro="pdf_output_data" filename="output.inner_distance_plot.pdf" />
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
37 <data format="txt" name="outputtxt" from_work_dir="output.inner_distance.txt" label="${tool.name} on ${on_string} (text)"/>
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
38 <data format="txt" name="outputfreqtxt" from_work_dir="output.inner_distance_freq.txt" label="${tool.name} on ${on_string} (frequency text)" />
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
39 <expand macro="rscript_output_data" filename="output.inner_distance_plot.r" />
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
40 </outputs>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
41
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
42 <tests>
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 <param name="input" value="pairend_strandspecific_51mer_hg19_chr1_1-100000.bam"/>
59
dbedfc5f5a3c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 247059e2527b66f1dbecf1e61496daef921040c3"
iuc
parents: 57
diff changeset
45 <param name="refgene" value="hg19_RefSeq_chr1_1-100000.bed" ftype="bed12"/>
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
46 <param name="rscript_output" value="true" />
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
47 <output name="outputtxt" file="output.inner_distance.txt" />
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
48 <output name="outputfreqtxt" file="output.inner_distance_freq.txt" />
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
49 <output name="outputpdf" file="output.inner_distance_plot.pdf" compare="sim_size"/>
59
dbedfc5f5a3c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 247059e2527b66f1dbecf1e61496daef921040c3"
iuc
parents: 57
diff changeset
50 <output name="outputr" file="output.inner_distance_plot_r" />
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
51 </test>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
52 </tests>
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
53
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
54 <help><![CDATA[
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
55 inner_distance.py
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
56 +++++++++++++++++
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 This module is used to calculate the inner distance (or insert size) between two paired RNA
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
59 reads. The distance is the mRNA length between two paired fragments. We first determine the
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
60 genomic (DNA) size between two paired reads: D_size = read2_start - read1_end, then
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
61
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
62 * if two paired reads map to the same exon: inner distance = D_size
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
63 * if two paired reads map to different exons:inner distance = D_size - intron_size
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
64 * if two paired reads map non-exonic region (such as intron and intergenic region): inner distance = D_size
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
65 * The inner_distance might be a negative value if two fragments were overlapped.
45
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 NOTE: Not all read pairs were used to estimate the inner distance distribution. Those low
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
68 quality, PCR duplication, multiple mapped reads were skipped.
45
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 Inputs
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
71 ++++++++++++++
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
72
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
73 Input BAM/SAM file
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
74 Alignment file in BAM/SAM format.
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
75
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
76 Reference gene model
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
77 Gene model in BED format.
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
78
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
79 Estimated Upper/Lower Bounds (defaults=250 and -250)
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
80 Estimated upper/lower bounds of inner distance (bp).
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 Step size (default=5)
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
83 Step size of histogram
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
84
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
85
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
86 Output
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
87 ++++++++++++++
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
88
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
89 1. output.inner_distance.txt:
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
90 - first column is read ID
57
f437057e46f1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 7d7cd4324af66710b89801a1a1c79fb8abf0d146
iuc
parents: 54
diff changeset
91 - second column is inner distance. Could be negative value if PE reads were overlapped or mapping error (e.g. Read1_start &lt; Read2_start, while Read1_end >> Read2_end due to spliced mapping of read1)
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
92 - third column indicates how paired reads were mapped: PE_within_same_exon, PE_within_diff_exon,PE_reads_overlap
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
93 2. output..inner_distance_freq.txt:
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
94 - inner distance starts
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
95 - inner distance ends
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
96 - number of read pairs
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
97 - note the first 2 columns are left side half open interval
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
98 3. output.inner_distance_plot.r: R script to generate histogram
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
99 4. output.inner_distance_plot.pdf: histogram plot
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
100
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
101 .. image:: $PATH_TO_IMAGES/inner_distance.png
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
102 :height: 600 px
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
103 :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
104 :scale: 80 %
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
105
51
09846d5169fa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rseqc commit 37fb1988971807c6a072e1afd98eeea02329ee83
iuc
parents: 49
diff changeset
106 @ABOUT@
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
107
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
108 ]]>
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
109 </help>
49
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
110
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
111 <expand macro="citations" />
6b33e31bda10 Uploaded tar based on https://github.com/lparsons/galaxy_tools/tree/master/tools/rseqc 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 45
diff changeset
112
45
eb339c5849bb Reupload, toolshed removed all files of previous version.
lparsons
parents:
diff changeset
113 </tool>