annotate inner_distance.xml @ 38:a447651be8ee

Reupload 2.3.7 fix (tarball upload issues)
author lparsons
date Wed, 23 Jul 2014 10:14:01 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
1 <tool id="rseqc_inner_distance" name="Inner Distance" version="1.1">
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
2 <description>calculate the inner distance (or insert size) between two paired RNA reads</description>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
3 <requirements>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
4 <requirement type="package" version="3.0.1">R</requirement>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
5 <requirement type="package" version="1.7.1">numpy</requirement>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
6 <requirement type="package" version="2.3.7">rseqc</requirement>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
7 </requirements>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
8 <command>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
9 inner_distance.py -i $input -o output -r $refgene
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
10
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
11 #if $bounds.hasLowerBound
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
12 -l $bounds.lowerBound
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
13 #end if
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
14
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
15 #if $bounds2.hasUpperBound
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
16 -u $bounds2.upperBound
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
17 #end if
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
18
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
19 #if $steps.step
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
20 -s $steps.stepSize
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
21 #end if
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
22 </command>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
23 <stdio>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
24 <exit_code range="1:" level="fatal" description="An error occured during execution, see stderr and stdout for more information" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
25 <regex match="[Ee]rror" source="both" description="An error occured during execution, see stderr and stdout for more information" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
26 </stdio>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
27 <inputs>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
28 <param name="input" type="data" format="bam,sam" label="input bam/sam file" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
29 <param name="refgene" type="data" format="bed" label="reference gene model" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
30 <conditional name="bounds">
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
31 <param name="hasLowerBound" type="boolean" label="Specify lower bound" value="false"/>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
32 <when value="true">
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
33 <param name="lowerBound" type="integer" value="-250" label="Estimated Lower Bound (bp, default=-250)" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
34 </when>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
35 </conditional>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
36 <conditional name="bounds2">
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
37 <param name="hasUpperBound" type="boolean" label="Specify upper bound" value="false" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
38 <when value="true">
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
39 <param name="upperBound" type="integer" value="250" label="Estimated Upper Bound (bp, default=250)" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
40 </when>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
41 </conditional>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
42 <conditional name="steps">
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
43 <param name="step" type="boolean" label="Specify step size" value="false" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
44 <when value="true">
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
45 <param name="stepSize" type="integer" value="5" label="Step size (bp, default=5)" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
46 </when>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
47 </conditional>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
48 </inputs>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
49 <outputs>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
50 <data format="txt" name="outputtxt" from_work_dir="output.inner_distance.txt" label="${tool.name} on ${on_string} (Text)"/>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
51 <data format="txt" name="outputfreqtxt" from_work_dir="output.inner_distance_freq.txt" label="${tool.name} on ${on_string} (Freq Text)" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
52 <data format="pdf" name="outputpdf" from_work_dir="output.inner_distance_plot.pdf" label="${tool.name} on ${on_string} (PDF)" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
53 <data format="txt" name="outputr" from_work_dir="output.inner_distance_plot.r" label="${tool.name} on ${on_string} (R Script)" />
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
54 </outputs>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
55 <help>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
56 inner_distance.py
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
57 +++++++++++++++++
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
58
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
59 This module is used to calculate the inner distance (or insert size) between two paired RNA
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
60 reads. The distance is the mRNA length between two paired fragments. We first determine the
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
61 genomic (DNA) size between two paired reads: D_size = read2_start - read1_end, then
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
62
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
63 * if two paired reads map to the same exon: inner distance = D_size
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
64 * if two paired reads map to different exons:inner distance = D_size - intron_size
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
65 * if two paired reads map non-exonic region (such as intron and intergenic region): inner distance = D_size
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
66 * The inner_distance might be a negative value if two fragments were overlapped.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
67
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
68 NOTE: Not all read pairs were used to estimate the inner distance distribution. Those low
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
69 quality, PCR duplication, multiple mapped reads were skipped.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
70
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
71 Inputs
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
72 ++++++++++++++
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
73
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
74 Input BAM/SAM file
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
75 Alignment file in BAM/SAM format.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
76
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
77 Reference gene model
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
78 Gene model in BED format.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
79
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
80 Estimated Upper/Lower Bounds (defaults=250 and -250)
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
81 Estimated upper/lower bounds of inner distance (bp).
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
82
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
83 Step size (default=5)
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
84 Step size of histogram
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
85
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
86
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
87 Output
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
88 ++++++++++++++
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
89
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
90 1. output.inner_distance.txt:
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
91 - first column is read ID
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
92 -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)
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
93 - third column indicates how paired reads were mapped: PE_within_same_exon, PE_within_diff_exon,PE_reads_overlap
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
94 2. output..inner_distance_freq.txt:
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
95 - inner distance starts
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
96 - inner distance ends
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
97 - number of read pairs
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
98 - note the first 2 columns are left side half open interval
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
99 3. output.inner_distance_plot.r: R script to generate histogram
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
100 4. output.inner_distance_plot.pdf: histogram plot
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
101
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
102 .. image:: http://rseqc.sourceforge.net/_images/inner_distance.png
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
103 :height: 600 px
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
104 :width: 600 px
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
105 :scale: 80 %
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
106
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
107
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
108 -----
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
109
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
110 About RSeQC
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
111 +++++++++++
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
112
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
113 The RSeQC_ package provides a number of useful modules that can comprehensively evaluate high throughput sequence data especially RNA-seq data. "Basic modules" quickly inspect sequence quality, nucleotide composition bias, PCR bias and GC bias, while "RNA-seq specific modules" investigate sequencing saturation status of both splicing junction detection and expression estimation, mapped reads clipping profile, mapped reads distribution, coverage uniformity over gene body, reproducibility, strand specificity and splice junction annotation.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
114
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
115 The RSeQC package is licensed under the GNU GPL v3 license.
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
116
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
117 .. image:: http://rseqc.sourceforge.net/_static/logo.png
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
118
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
119 .. _RSeQC: http://rseqc.sourceforge.net/
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
120
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
121
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
122 </help>
a447651be8ee Reupload 2.3.7 fix (tarball upload issues)
lparsons
parents:
diff changeset
123 </tool>