annotate inner_distance.xml @ 2:ebadf9ee2d08

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