annotate clipping_profile.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_clipping_profile" name="Clipping Profile" version="1.1">
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
2 <description>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
3 estimates clipping profile of RNA-seq reads from BAM or SAM file
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
4 </description>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
5 <requirements>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
6 <requirement type="package" version="2.11.0">R</requirement>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
7 <requirement type="package" version="1.7.1">numpy</requirement>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
8 <requirement type="package" version="2.3.7">rseqc</requirement>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
9 </requirements>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
10 <command>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
11 clipping_profile.py -i $input -o output
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
12 </command>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
13 <stdio>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
14 <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
15 <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
16 </stdio>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
17 <inputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
18 <param name="input" type="data" label="Input .bam/.sam File" format="bam,sam" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
19 </inputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
20 <outputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
21 <data format="xls" name="outputxls" from_work_dir="output.clipping_profile.xls" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
22 <data format="txt" name="outputr" from_work_dir="output.clipping_profile.r" />
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
23 </outputs>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
24 <help>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
25 clipping_profile.py
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
26 +++++++++++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
27
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
28 This program is used to estimate clipping profile of RNA-seq reads from BAM or SAM file.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
29 Note that to use this funciton, CIGAR strings within SAM/BAM file should have 'S' operation
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
30 (This means your reads aligner should support clipped mapping).
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
31
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
32 Inputs
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
33 ++++++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
34
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
35 Input BAM/SAM file
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
36 Alignment file in BAM/SAM format.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
37
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
38
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
39 Sample Output
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
40 ++++++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
41
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
42 .. image:: http://rseqc.sourceforge.net/_images/clipping_good.png
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
43 :height: 600 px
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
44 :width: 600 px
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
45 :scale: 80 %
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
46
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
47 -----
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
48
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
49 About RSeQC
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
50 +++++++++++
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
51
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
52 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
53
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
54 The RSeQC package is licensed under the GNU GPL v3 license.
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
55
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
56 .. image:: http://rseqc.sourceforge.net/_static/logo.png
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
57
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
58 .. _RSeQC: http://rseqc.sourceforge.net/
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
59
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
60 </help>
f85fac5a4dce Import from BitBucket tip
lparsons
parents:
diff changeset
61 </tool>