Mercurial > repos > nilesh > rseqc

annotate geneBody_coverage.xml @ 48:2e6190c29c54 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Upload tar.gz again - toolshed removed all files (grrr...)
author lparsons
date Tue, 21 Apr 2015 10:27:06 -0400
parents
children 6b33e31bda10
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
48
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
1 <tool id="rseqc_geneBody_coverage" name="Gene Body Converage (BAM)" version="2.4">
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
2 <description>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
3 Read coverage over gene body.
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
4 </description>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
5 <requirements>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
6 <requirement type="package" version="3.0.3">R</requirement>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
7 <requirement type="package" version="1.7.1">numpy</requirement>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
8 <requirement type="package" version="2.4">rseqc</requirement>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
9 </requirements>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
10 <command>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
11 #set $safename = ''.join(c in '_0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ' and c or '_' for c in $input.display_name)
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
12 #set $fname = "d1_" + str($safename) + ".bam"
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
13 ln -s '${input}' '${fname}' &amp;&amp;
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
14 ln -s '${input.metadata.bam_index}' '${fname}.bai' &amp;&amp;
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
15 echo '${fname}' > input_list.txt &amp;&amp;
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
16 #for $i, $additional_input in enumerate($additionalinputs):
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
17 #set $index = $i+2
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
18 #set $safename = ''.join(c in '_0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ' and c or '_' for c in $additional_input.file.display_name)
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
19 #set $fname = 'd' + str($index) + '_' + str($safename) + ".bam"
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
20 ln -s '$additional_input.file' '${fname}' &amp;&amp;
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
21 ln -s '$additional_input.file.metadata.bam_index' '${fname}.bai' &amp;&amp;
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
22 echo '${fname}' >> input_list.txt &amp;&amp;
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
23 #end for
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
24 geneBody_coverage.py -i input_list.txt -r $refgene --minimum_length $minimum_length -o output
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
25 </command>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
26 <stdio>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
27 <exit_code range="1:" level="fatal" description="An error occured during execution, see stderr and stdout for more information" />
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
28 <regex match="[Ee]rror" source="both" description="An error occured during execution, see stderr and stdout for more information" />
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
29 </stdio>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
30 <inputs>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
31 <param name="input" type="data" label="Additional input .bam files" format="bam" />
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
32 <repeat name="additionalinputs" title="Input .bam file">
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
33 <param name="file" type="data" label="Input .bam file" format="bam" />
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
34 </repeat>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
35 <param name="refgene" type="data" label="Reference Genome" format="bed" />
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
36 <param name="minimum_length" type="integer" value="100" label="Minimum mRNA length" help="Minimum mRNA length (bp). mRNA that are shorter than this value will be skipped (default is 100)." />
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
37 </inputs>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
38 <outputs>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
39 <data name="outputcurvespdf" format="pdf" from_work_dir="output.geneBodyCoverage.curves.pdf" label="${tool.name} on ${on_string} (Curves PDF)" />
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
40 <data name="outputheatmappdf" format="pdf" from_work_dir="output.geneBodyCoverage.heatMap.pdf" label="${tool.name} on ${on_string} (HeatMap PDF)">
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
41 <filter>len(additionalinputs) >= 2</filter>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
42 </data>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
43 <data name="outputr" format="txt" from_work_dir="output.geneBodyCoverage.r" label="${tool.name} on ${on_string} (R Script)" />
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
44 <data name="outputtxt" format="txt" from_work_dir="output.geneBodyCoverage.txt" label="${tool.name} on ${on_string} (Text)" />
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
45 </outputs>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
46 <help>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
47 geneBody_coverage.py
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
48 ++++++++++++++++++++
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
49
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
50 Read coverage over gene body. This module is used to check if read coverage is uniform and if there is any 5\'/3\' bias. This module scales all transcripts to 100 nt and calculates the number of reads covering each nucleotide position. Finally, it generates plots illustrating the coverage profile along the gene body.
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
51
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
52 If 3 or more BAM files were provided. This program generates a lineGraph and a heatmap. If fewer than 3 BAM files were provided, only lineGraph is generated. See below for examples.
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
53
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
54 When heatmap is generated, samples are ranked by the "skewness" of the coverage: Sample with best (worst) coverage will be displayed at the top (bottom) of the heatmap.
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
55 Coverage skewness was measured by `Pearson’s skewness coefficients &lt;http://en.wikipedia.org/wiki/Skewness#Pearson.27s_skewness_coefficients>`_
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
56
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
57 Inputs
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
58 ++++++++++++++
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
59
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
60 Input BAM/SAM file
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
61 Alignment file in BAM/SAM format.
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
62
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
63 Reference gene model
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
64 Gene Model in BED format.
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
65
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
66 Minimum mRNA length
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
67 Minimum mRNA length (bp). mRNA that are shorter than this value will be skipped (default is 100).
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
68
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
69 Outputs
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
70 ++++++++++++++
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
71 Text
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
72 Table that includes the data used to generate the plots
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
73
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
74 R Script
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
75 R script file that reads the data and generates the plot
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
76
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
77 PDF
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
78 The final plot, in PDF format
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
79
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
80 Example plots:
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
81 .. image:: http://rseqc.sourceforge.net/_images/Aug_26.geneBodyCoverage.curves.png
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
82 :height: 600 px
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
83 :width: 600 px
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
84 :scale: 80 %
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
85
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
86 .. image:: http://rseqc.sourceforge.net/_images/Aug_26.geneBodyCoverage.heatMap.png
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
87 :height: 600 px
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
88 :width: 600 px
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
89 :scale: 80 %
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
90
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
91 -----
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
92
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
93 About RSeQC
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
94 +++++++++++
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
95
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
96 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.
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
97
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
98 The RSeQC package is licensed under the GNU GPL v3 license.
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
99
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
100 .. image:: http://rseqc.sourceforge.net/_static/logo.png
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
101
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
102 .. _RSeQC: http://rseqc.sourceforge.net/
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
103
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
104
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
105
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
106 </help>
2e6190c29c54 Upload tar.gz again - toolshed removed all files (grrr...)
lparsons
parents:
diff changeset
107 </tool>