annotate infer_experiment.xml @ 0:f85fac5a4dce draft

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