annotate read_duplication.xml @ 0:f85fac5a4dce draft

Import from BitBucket tip
author lparsons
date Mon, 07 Oct 2013 14:36:38 -0400
parents
children 5eef4ef0ab25
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_read_duplication" name="Read Duplication" version="1.1">
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
2 <description>determines reads duplication rate with sequence-based and mapping-based strategies</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="2.11.0">R</requirement>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
5 <requirement type="package" version="1.7.1">numpy</requirement>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
6 <requirement type="package" version="2.3.7">rseqc</requirement>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
7 </requirements>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
8 <command>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
9 read_duplication.py -i $input -o output -u $upLimit
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
10 </command>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
11 <stdio>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
12 <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
13 <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
14 </stdio>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
15 <inputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
16 <param name="input" type="data" format="bam,sam" label="input bam/sam file" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
17 <param name="upLimit" type="integer" label="Upper Limit of Plotted Duplicated Times (default=500)" value="500" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
18 </inputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
19 <outputs>
f85fac5a4dce Import from BitBucket tip
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)"/>
f85fac5a4dce Import from BitBucket tip
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)"/>
f85fac5a4dce Import from BitBucket tip
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)" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
23 <data format="pdf" name="outputpdf" from_work_dir="output.DupRate_plot.pdf" label="${tool.name} on ${on_string} (PDF)" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
24 </outputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
25 <help>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
26 read_duplication.py
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
27 +++++++++++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
28
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
29 Two strategies were used to determine reads duplication rate:
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
30
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
31 * Sequence based: reads with exactly the same sequence content are regarded as duplicated reads.
f85fac5a4dce Import from BitBucket tip
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.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
33
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
34 Inputs
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
35 ++++++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
36
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
37 Input BAM/SAM file
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
38 Alignment file in BAM/SAM format.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
39
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
40 Upper Limit of Plotted Duplicated Times (default=500)
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
41 Only used for plotting.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
42
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
43 Output
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
44 ++++++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
45
f85fac5a4dce Import from BitBucket tip
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.
f85fac5a4dce Import from BitBucket tip
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.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
48 3. output.DupRate_plot.r: R script to generate pdf file
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
49 4. output.DupRate_plot.pdf: graphical output generated from R script
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
50
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
51 .. image:: http://rseqc.sourceforge.net/_images/duplicate.png
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
52 :height: 600 px
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
53 :width: 600 px
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
54 :scale: 80 %
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
55
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
56 -----
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
57
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
58 About RSeQC
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
59 +++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
60
f85fac5a4dce Import from BitBucket tip
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.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
62
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
63 The RSeQC package is licensed under the GNU GPL v3 license.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
64
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
65 .. image:: http://rseqc.sourceforge.net/_static/logo.png
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
66
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
67 .. _RSeQC: http://rseqc.sourceforge.net/
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
68
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
69
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
70 </help>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
71 </tool>