Mercurial > repos > nilesh > rseqc

annotate infer_experiment.xml @ 45:eb339c5849bb draft

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