annotate infer_experiment.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="infer_experiment" name="Infer Experiment">
f92b87abef3d just xmls
nilesh
parents:
diff changeset
2 <description>speculates how RNA-seq were configured</description>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
3 <requirements>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
4 <requirement type="package" version="2.3.7">rseqc</requirement>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
5 </requirements>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
6 <command interpreter="python"> infer_experiment.py -i $input -r $refgene
f92b87abef3d just xmls
nilesh
parents:
diff changeset
7
f92b87abef3d just xmls
nilesh
parents:
diff changeset
8 #if $sample_size.boolean
f92b87abef3d just xmls
nilesh
parents:
diff changeset
9 -s $sample_size.size
f92b87abef3d just xmls
nilesh
parents:
diff changeset
10 #end if
f92b87abef3d just xmls
nilesh
parents:
diff changeset
11
f92b87abef3d just xmls
nilesh
parents:
diff changeset
12 > $output
f92b87abef3d just xmls
nilesh
parents:
diff changeset
13 </command>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
14 <inputs>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
15 <param name="input" type="data" format="bam,sam" label="Input BAM/SAM file" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
16 <param name="refgene" type="data" format="bed" label="Reference gene model in bed format" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
17 <conditional name="sample_size">
f92b87abef3d just xmls
nilesh
parents:
diff changeset
18 <param name="boolean" type="boolean" label="Modify usable sampled reads" value="false" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
19 <when value="true">
f92b87abef3d just xmls
nilesh
parents:
diff changeset
20 <param name="size" type="integer" label="Number of usable sampled reads (default = 200000)" value="200000" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
21 </when>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
22 </conditional>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
23 </inputs>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
24 <outputs>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
25 <data format="txt" name="output" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
26 </outputs>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
27 <tests>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
28 <test>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
29 <param name="input" value="Pairend_nonStrandSpecific_36mer_Human_hg19.bam" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
30 <param name="refgene" value="hg19_RefSeq.bed" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
31 <output name="output" file="inferexpout.txt" />
f92b87abef3d just xmls
nilesh
parents:
diff changeset
32 </test>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
33 </tests>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
34 <help>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
35 .. image:: https://code.google.com/p/rseqc/logo?cct=1336721062
f92b87abef3d just xmls
nilesh
parents:
diff changeset
36
f92b87abef3d just xmls
nilesh
parents:
diff changeset
37 -----
f92b87abef3d just xmls
nilesh
parents:
diff changeset
38
f92b87abef3d just xmls
nilesh
parents:
diff changeset
39 About RSeQC
f92b87abef3d just xmls
nilesh
parents:
diff changeset
40 +++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
41
f92b87abef3d just xmls
nilesh
parents:
diff changeset
42 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
43
f92b87abef3d just xmls
nilesh
parents:
diff changeset
44 The RSeQC package is licensed under the GNU GPL v3 license.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
45
f92b87abef3d just xmls
nilesh
parents:
diff changeset
46 Inputs
f92b87abef3d just xmls
nilesh
parents:
diff changeset
47 ++++++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
48
f92b87abef3d just xmls
nilesh
parents:
diff changeset
49 Input BAM/SAM file
f92b87abef3d just xmls
nilesh
parents:
diff changeset
50 Alignment file in BAM/SAM format.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
51
f92b87abef3d just xmls
nilesh
parents:
diff changeset
52 Reference gene model
f92b87abef3d just xmls
nilesh
parents:
diff changeset
53 Gene model in BED format.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
54
f92b87abef3d just xmls
nilesh
parents:
diff changeset
55 Number of usable sampled reads (default=200000)
f92b87abef3d just xmls
nilesh
parents:
diff changeset
56 Number of usable reads sampled from SAM/BAM file. More reads will give more accurate estimation, but make program little slower.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
57
f92b87abef3d just xmls
nilesh
parents:
diff changeset
58
f92b87abef3d just xmls
nilesh
parents:
diff changeset
59 Output
f92b87abef3d just xmls
nilesh
parents:
diff changeset
60 ++++++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
61 This program is used to speculate how RNA-seq sequencing were configured, especially how reads were stranded for strand-specific RNA-seq data, through comparing reads' mapping information to the underneath gene model. Generally, strand specific RNA-seq data should be handled differently in both visualization and RPKM calculation.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
62
f92b87abef3d just xmls
nilesh
parents:
diff changeset
63 For pair-end RNA-seq, there are two different ways to strand reads:
f92b87abef3d just xmls
nilesh
parents:
diff changeset
64
f92b87abef3d just xmls
nilesh
parents:
diff changeset
65 1) 1++,1--,2+-,2-+
f92b87abef3d just xmls
nilesh
parents:
diff changeset
66 - read1 mapped to '+' strand indicates parental gene on '+' strand
f92b87abef3d just xmls
nilesh
parents:
diff changeset
67 - read1 mapped to '-' strand indicates parental gene on '-' strand
f92b87abef3d just xmls
nilesh
parents:
diff changeset
68 - read2 mapped to '+' strand indicates parental gene on '-' strand
f92b87abef3d just xmls
nilesh
parents:
diff changeset
69 - read2 mapped to '-' strand indicates parental gene on '+' strand
f92b87abef3d just xmls
nilesh
parents:
diff changeset
70 2) 1+-,1-+,2++,2--
f92b87abef3d just xmls
nilesh
parents:
diff changeset
71 - read1 mapped to '+' strand indicates parental gene on '-' strand
f92b87abef3d just xmls
nilesh
parents:
diff changeset
72 - read1 mapped to '-' strand indicates parental gene on '+' strand
f92b87abef3d just xmls
nilesh
parents:
diff changeset
73 - read2 mapped to '+' strand indicates parental gene on '+' strand
f92b87abef3d just xmls
nilesh
parents:
diff changeset
74 - read2 mapped to '-' strand indicates parental gene on '-' strand
f92b87abef3d just xmls
nilesh
parents:
diff changeset
75
f92b87abef3d just xmls
nilesh
parents:
diff changeset
76 For single-end RNA-seq, there are also two different ways to strand reads:
f92b87abef3d just xmls
nilesh
parents:
diff changeset
77
f92b87abef3d just xmls
nilesh
parents:
diff changeset
78 1) ++,--
f92b87abef3d just xmls
nilesh
parents:
diff changeset
79 -read mapped to '+' strand indicates parental gene on '+' strand
f92b87abef3d just xmls
nilesh
parents:
diff changeset
80 - read mapped to '-' strand indicates parental gene on '-' strand
f92b87abef3d just xmls
nilesh
parents:
diff changeset
81 2) +-,-+
f92b87abef3d just xmls
nilesh
parents:
diff changeset
82 - read mapped to '+' strand indicates parental gene on '-' strand
f92b87abef3d just xmls
nilesh
parents:
diff changeset
83 - read mapped to '-' strand indicates parental gene on '+' strand
f92b87abef3d just xmls
nilesh
parents:
diff changeset
84
f92b87abef3d just xmls
nilesh
parents:
diff changeset
85 Example Output
f92b87abef3d just xmls
nilesh
parents:
diff changeset
86 ++++++++++++++
f92b87abef3d just xmls
nilesh
parents:
diff changeset
87
f92b87abef3d just xmls
nilesh
parents:
diff changeset
88 **Example1** ::
f92b87abef3d just xmls
nilesh
parents:
diff changeset
89
f92b87abef3d just xmls
nilesh
parents:
diff changeset
90 =========================================================
f92b87abef3d just xmls
nilesh
parents:
diff changeset
91 This is PairEnd Data ::
f92b87abef3d just xmls
nilesh
parents:
diff changeset
92
f92b87abef3d just xmls
nilesh
parents:
diff changeset
93 Fraction of reads explained by "1++,1--,2+-,2-+": 0.4992
f92b87abef3d just xmls
nilesh
parents:
diff changeset
94 Fraction of reads explained by "1+-,1-+,2++,2--": 0.5008
f92b87abef3d just xmls
nilesh
parents:
diff changeset
95 Fraction of reads explained by other combinations: 0.0000
f92b87abef3d just xmls
nilesh
parents:
diff changeset
96 =========================================================
f92b87abef3d just xmls
nilesh
parents:
diff changeset
97
f92b87abef3d just xmls
nilesh
parents:
diff changeset
98 *Conclusion*: We can infer that this is NOT a strand specific because 50% of reads can be explained by "1++,1--,2+-,2-+", while the other 50% can be explained by "1+-,1-+,2++,2--".
f92b87abef3d just xmls
nilesh
parents:
diff changeset
99
f92b87abef3d just xmls
nilesh
parents:
diff changeset
100 **Example2** ::
f92b87abef3d just xmls
nilesh
parents:
diff changeset
101
f92b87abef3d just xmls
nilesh
parents:
diff changeset
102 ============================================================
f92b87abef3d just xmls
nilesh
parents:
diff changeset
103 This is PairEnd Data
f92b87abef3d just xmls
nilesh
parents:
diff changeset
104
f92b87abef3d just xmls
nilesh
parents:
diff changeset
105 Fraction of reads explained by "1++,1--,2+-,2-+": 0.9644 ::
f92b87abef3d just xmls
nilesh
parents:
diff changeset
106 Fraction of reads explained by "1+-,1-+,2++,2--": 0.0356
f92b87abef3d just xmls
nilesh
parents:
diff changeset
107 Fraction of reads explained by other combinations: 0.0000
f92b87abef3d just xmls
nilesh
parents:
diff changeset
108 ============================================================
f92b87abef3d just xmls
nilesh
parents:
diff changeset
109
f92b87abef3d just xmls
nilesh
parents:
diff changeset
110 *Conclusion*: We can infer that this is a strand-specific RNA-seq data. strandness of read1 is consistent with that of gene model, while strandness of read2 is opposite to the strand of reference gene model.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
111
f92b87abef3d just xmls
nilesh
parents:
diff changeset
112 **Example3** ::
f92b87abef3d just xmls
nilesh
parents:
diff changeset
113
f92b87abef3d just xmls
nilesh
parents:
diff changeset
114 =========================================================
f92b87abef3d just xmls
nilesh
parents:
diff changeset
115 This is SingleEnd Data ::
f92b87abef3d just xmls
nilesh
parents:
diff changeset
116
f92b87abef3d just xmls
nilesh
parents:
diff changeset
117 Fraction of reads explained by "++,--": 0.9840 ::
f92b87abef3d just xmls
nilesh
parents:
diff changeset
118 Fraction of reads explained by "+-,-+": 0.0160
f92b87abef3d just xmls
nilesh
parents:
diff changeset
119 Fraction of reads explained by other combinations: 0.0000
f92b87abef3d just xmls
nilesh
parents:
diff changeset
120 =========================================================
f92b87abef3d just xmls
nilesh
parents:
diff changeset
121
f92b87abef3d just xmls
nilesh
parents:
diff changeset
122 *Conclusion*: This is single-end, strand specific RNA-seq data. Strandness of reads are concordant with strandness of reference gene.
f92b87abef3d just xmls
nilesh
parents:
diff changeset
123 </help>
f92b87abef3d just xmls
nilesh
parents:
diff changeset
124 </tool>