annotate infer_experiment.xml @ 31:cc5eaa9376d8

Lance's updates
author nilesh
date Wed, 02 Oct 2013 02:20:04 -0400
parents 8dbd613bd835
children 580ee0c4bc4e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
1 <tool id="infer_experiment" name="Infer Experiment" version="1.1">
19
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
2 <description>speculates how RNA-seq were configured</description>
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
3 <requirements>
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
4 <requirement type="package" version="1.7.1">numpy</requirement>
19
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
5 <requirement type="package" version="2.3.7">rseqc</requirement>
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
6 </requirements>
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
7 <command> infer_experiment.py -i $input -r $refgene
19
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
8
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
9 #if $sample_size.boolean
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
10 -s $sample_size.size
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
11 #end if
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
12
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
13 > $output
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
14 </command>
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
15 <inputs>
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
16 <param name="input" type="data" format="bam,sam" label="Input BAM/SAM file" />
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
17 <param name="refgene" type="data" format="bed" label="Reference gene model in bed format" />
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
18 <conditional name="sample_size">
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
19 <param name="boolean" type="boolean" label="Modify usable sampled reads" value="false" />
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
20 <when value="true">
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
21 <param name="size" type="integer" label="Number of usable sampled reads (default = 200000)" value="200000" />
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
22 </when>
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
23 </conditional>
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
24 </inputs>
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
25 <outputs>
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
26 <data format="txt" name="output" />
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
27 </outputs>
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
28 <stdio>
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
29 <exit_code range="1:" level="fatal" description="An error occured during execution, see stderr and stdout for more information" />
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
30 <regex match="[Ee]rror" source="both" description="An error occured during execution, see stderr and stdout for more information" />
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
31 </stdio>
19
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
32 <help>
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
33 infer_experiment.py
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
34 +++++++++++++++++++
19
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
35
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
36 This program is used to speculate how RNA-seq sequencing were configured, especially how
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
37 reads were stranded for strand-specific RNA-seq data, through comparing reads' mapping
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
38 information to the underneath gene model.
19
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
39
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
40
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
41 Inputs
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
42 ++++++++++++++
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
43
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
44 Input BAM/SAM file
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
45 Alignment file in BAM/SAM format.
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
46
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
47 Reference gene model
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
48 Gene model in BED format.
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
49
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
50 Number of usable sampled reads (default=200000)
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
51 Number of usable reads sampled from SAM/BAM file. More reads will give more accurate estimation, but make program little slower.
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
52
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
53 Outputs
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
54 +++++++
19
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
55
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
56 For pair-end RNA-seq, there are two different
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
57 ways to strand reads (such as Illumina ScriptSeq protocol):
19
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
58
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
59 1. 1++,1--,2+-,2-+
19
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
60
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
61 * read1 mapped to '+' strand indicates parental gene on '+' strand
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
62 * read1 mapped to '-' strand indicates parental gene on '-' strand
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
63 * read2 mapped to '+' strand indicates parental gene on '-' strand
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
64 * read2 mapped to '-' strand indicates parental gene on '+' strand
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
65
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
66 2. 1+-,1-+,2++,2--
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
67
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
68 * read1 mapped to '+' strand indicates parental gene on '-' strand
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
69 * read1 mapped to '-' strand indicates parental gene on '+' strand
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
70 * read2 mapped to '+' strand indicates parental gene on '+' strand
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
71 * read2 mapped to '-' strand indicates parental gene on '-' strand
19
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
72
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
73 For single-end RNA-seq, there are also two different ways to strand reads:
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
74
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
75 1. ++,--
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
76
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
77 * read mapped to '+' strand indicates parental gene on '+' strand
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
78 * read mapped to '-' strand indicates parental gene on '-' strand
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
79
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
80 2. +-,-+
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
81
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
82 * read mapped to '+' strand indicates parental gene on '-' strand
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
83 * read mapped to '-' strand indicates parental gene on '+' strand
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
84
19
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
85
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
86 Example Output
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
87 ++++++++++++++
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
88
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
89 **Example1** ::
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
90
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
91 =========================================================
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
92 This is PairEnd Data ::
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
93
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
94 Fraction of reads explained by "1++,1--,2+-,2-+": 0.4992
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
95 Fraction of reads explained by "1+-,1-+,2++,2--": 0.5008
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
96 Fraction of reads explained by other combinations: 0.0000
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
97 =========================================================
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
98
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
99 *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--".
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
100
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
101 **Example2** ::
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
102
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
103 ============================================================
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
104 This is PairEnd Data
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
105
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
106 Fraction of reads explained by "1++,1--,2+-,2-+": 0.9644 ::
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
107 Fraction of reads explained by "1+-,1-+,2++,2--": 0.0356
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
108 Fraction of reads explained by other combinations: 0.0000
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
109 ============================================================
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
110
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
111 *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.
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
112
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
113 **Example3** ::
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
114
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
115 =========================================================
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
116 This is SingleEnd Data ::
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
117
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
118 Fraction of reads explained by "++,--": 0.9840 ::
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
119 Fraction of reads explained by "+-,-+": 0.0160
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
120 Fraction of reads explained by other combinations: 0.0000
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
121 =========================================================
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
122
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
123 *Conclusion*: This is single-end, strand specific RNA-seq data. Strandness of reads are concordant with strandness of reference gene.
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
124
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
125
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
126 -----
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
127
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
128 About RSeQC
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
129 +++++++++++
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
130
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
131 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.
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
132
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
133 The RSeQC package is licensed under the GNU GPL v3 license.
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
134
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
135 .. image:: http://rseqc.sourceforge.net/_static/logo.png
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
136
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
137 .. _RSeQC: http://rseqc.sourceforge.net/
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
138
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
139
19
8dbd613bd835 Uploaded
nilesh
parents:
diff changeset
140 </help>
31
cc5eaa9376d8 Lance's updates
nilesh
parents: 19
diff changeset
141 </tool>