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