annotate read_duplication.xml @ 5:31a43978eaa9 draft default tip

Uploaded
author bgruening
date Sat, 25 Apr 2015 10:07:21 -0400
parents 49ed5952a8b8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
1 <tool id="rseqc_read_duplication" name="Read Duplication" version="2.4">
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
2 <description>determines reads duplication rate with sequence-based and mapping-based strategies</description>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
3 <requirements>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
4 <requirement type="package" version="3.0.3">R</requirement>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
5 <requirement type="package" version="1.7.1">numpy</requirement>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
6 <requirement type="package" version="2.4">rseqc</requirement>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
7 </requirements>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
8 <command>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
9 read_duplication.py -i $input -o output -u $upLimit
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
10 </command>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
11 <stdio>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
12 <exit_code range="1:" level="fatal" description="An error occured during execution, see stderr and stdout for more information" />
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
13 <regex match="[Ee]rror" source="both" description="An error occured during execution, see stderr and stdout for more information" />
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
14 </stdio>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
15 <inputs>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
16 <param name="input" type="data" format="bam,sam" label="input bam/sam file" />
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
17 <param name="upLimit" type="integer" label="Upper Limit of Plotted Duplicated Times (default=500)" value="500" />
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
18 </inputs>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
19 <outputs>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
20 <data format="xls" name="outputxls" from_work_dir="output.dup.pos.DupRate.xls" label="${tool.name} on ${on_string} (Position XLS)"/>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
21 <data format="xls" name="outputseqxls" from_work_dir="output.dup.seq.DupRate.xls" label="${tool.name} on ${on_string} (Sequence XLS)"/>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
22 <data format="txt" name="outputr" from_work_dir="output.DupRate_plot.r" label="${tool.name} on ${on_string} (R Script)" />
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
23 <data format="pdf" name="outputpdf" from_work_dir="output.DupRate_plot.pdf" label="${tool.name} on ${on_string} (PDF)" />
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
24 </outputs>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
25 <help>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
26 read_duplication.py
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
27 +++++++++++++++++++
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
28
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
29 Two strategies were used to determine reads duplication rate:
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
30
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
31 * Sequence based: reads with exactly the same sequence content are regarded as duplicated reads.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
32 * Mapping based: reads mapped to the same genomic location are regarded as duplicated reads. For splice reads, reads mapped to the same starting position and splice the same way are regarded as duplicated reads.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
33
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
34 Inputs
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
35 ++++++++++++++
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
36
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
37 Input BAM/SAM file
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
38 Alignment file in BAM/SAM format.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
39
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
40 Upper Limit of Plotted Duplicated Times (default=500)
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
41 Only used for plotting.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
42
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
43 Output
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
44 ++++++++++++++
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
45
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
46 1. output.dup.pos.DupRate.xls: Read duplication rate determined from mapping position of read. First column is "occurrence" or duplication times, second column is number of uniquely mapped reads.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
47 2. output.dup.seq.DupRate.xls: Read duplication rate determined from sequence of read. First column is "occurrence" or duplication times, second column is number of uniquely mapped reads.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
48 3. output.DupRate_plot.r: R script to generate pdf file
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
49 4. output.DupRate_plot.pdf: graphical output generated from R script
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
50
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
51 .. image:: http://rseqc.sourceforge.net/_images/duplicate.png
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
52 :height: 600 px
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
53 :width: 600 px
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
54 :scale: 80 %
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
55
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
56 -----
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
57
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
58 About RSeQC
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
59 +++++++++++
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
60
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
61 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.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
62
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
63 The RSeQC package is licensed under the GNU GPL v3 license.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
64
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
65 .. image:: http://rseqc.sourceforge.net/_static/logo.png
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
66
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
67 .. _RSeQC: http://rseqc.sourceforge.net/
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
68
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
69
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
70 </help>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
71 </tool>