annotate inner_distance.xml @ 23:6a354a3248b6

Uploaded
author nilesh
date Thu, 11 Jul 2013 12:25:16 -0400
parents adc934fb9a76
children cc5eaa9376d8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
1 <tool id="inner_distance" name="Inner Distance">
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
2 <description>calculate the inner distance (or insert size) between two paired RNA reads</description>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
3 <requirements>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
4 <requirement type="package" version="2.15.1">R</requirement>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
5 <requirement type="package" version="2.3.7">rseqc</requirement>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
6 </requirements>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
7 <command interpreter="python"> inner_distance.py -i $input -o output -r $refgene
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
8
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
9 #if $bounds.hasLowerBound
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
10 -l $bounds.lowerBound
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
11 #end if
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
12
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
13 #if $bounds2.hasUpperBound
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
14 -u $bounds2.upperBound
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
15 #end if
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
16
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
17 #if $steps.step
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
18 -s $steps.stepSize
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
19 #end if
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
20 </command>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
21 <inputs>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
22 <param name="input" type="data" format="bam,sam" label="input bam/sam file" />
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
23 <param name="refgene" type="data" format="bed" label="reference gene model" />
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
24 <conditional name="bounds">
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
25 <param name="hasLowerBound" type="boolean" label="Specify lower bound" value="false"/>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
26 <when value="true">
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
27 <param name="lowerBound" type="integer" value="-250" label="Estimated Lower Bound (bp, default=-250)" />
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
28 </when>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
29 </conditional>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
30 <conditional name="bounds2">
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
31 <param name="hasUpperBound" type="boolean" label="Specify upper bound" value="false" />
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
32 <when value="true">
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
33 <param name="upperBound" type="integer" value="250" label="Estimated Upper Bound (bp, default=250)" />
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
34 </when>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
35 </conditional>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
36 <conditional name="steps">
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
37 <param name="step" type="boolean" label="Specify step size" value="false" />
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
38 <when value="true">
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
39 <param name="stepSize" type="integer" value="5" label="Step size (bp, default=5)" />
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
40 </when>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
41 </conditional>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
42 </inputs>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
43 <outputs>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
44 <data format="txt" name="outputtxt" from_work_dir="output.inner_distance.txt"/>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
45 <data format="txt" name="outputfreqtxt" from_work_dir="output.inner_distance_freq.txt" />
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
46 <data format="pdf" name="outputpdf" from_work_dir="output.inner_distance_plot.pdf" />
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
47 <data format="r" name="outputr" from_work_dir="output.inner_distance_plot.r" />
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
48 </outputs>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
49 <help>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
50 .. image:: https://code.google.com/p/rseqc/logo?cct=1336721062
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
51
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
52 -----
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
53
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
54 About RSeQC
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
55 +++++++++++
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
56
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
57 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.
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
58
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
59 The RSeQC package is licensed under the GNU GPL v3 license.
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
60
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
61 Inputs
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
62 ++++++++++++++
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
63
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
64 Input BAM/SAM file
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
65 Alignment file in BAM/SAM format.
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
66
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
67 Reference gene model
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
68 Gene model in BED format.
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
69
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
70 Estimated Upper/Lower Bounds (defaults=250 and -250)
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
71 Estimated upper/lower bounds of inner distance (bp).
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
72
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
73 Step size (default=5)
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
74 Step size of histogram
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
75
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
76
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
77 Output
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
78 ++++++++++++++
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
79
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
80 1. output.inner_distance.txt:
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
81 - first column is read ID
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
82 -second column is inner distance. Could be negative value if PE reads were overlapped or mapping error (e.g. Read1_start < Read2_start, while Read1_end >> Read2_end due to spliced mapping of read1)
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
83 - third column indicates how paired reads were mapped: PE_within_same_exon, PE_within_diff_exon,PE_reads_overlap
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
84 2. output..inner_distance_freq.txt:
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
85 - inner distance starts
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
86 - inner distance ends
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
87 - number of read pairs
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
88 - note the first 2 columns are left side half open interval
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
89 3. output.inner_distance_plot.r: R script to generate histogram
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
90 4. output.inner_distance_plot.pdf: histogram plot
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
91
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
92 .. image:: http://dldcc-web.brc.bcm.edu/lilab/liguow/RSeQC/figure/inner_distance.png
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
93
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
94 </help>
adc934fb9a76 Uploaded
nilesh
parents:
diff changeset
95 </tool>