annotate bam2wig.xml @ 6:e994caf2503d

Lance's updates
author nilesh
date Wed, 02 Oct 2013 02:09:28 -0400
parents dc3b3b88fbab
children bc65a465caed
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
1 <tool id="bam2wig" name="BAM to Wiggle">
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
2 <description>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
3 converts all types of RNA-seq data from .bam to .wig
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
4 </description>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
5 <requirements>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
6 <requirement type="package" version="2.3.7">rseqc</requirement>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
7 </requirements>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
8 <command interpreter="python">
6
e994caf2503d Lance's updates
nilesh
parents: 1
diff changeset
9 samtoolshelper.py bam2wig.py -i $input -s $chromsize -o outfile
1
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
10
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
11 #if str($strand_type.strand_specific) == "pair"
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
12 -d
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
13 #if str($strand_type.pair_type) == "sd"
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
14 '1++,1--,2+-,2-+'
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
15 #else
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
16 '1+-,1-+,2++,2--'
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
17 #end if
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
18 #end if
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
19
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
20 #if str($strand_type.strand_specific) == "single"
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
21 -d
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
22 #if str($strand_type.single_type) == "s"
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
23 '++,--'
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
24 #else
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
25 '+-,-+'
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
26 #end if
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
27 #end if
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
28
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
29 #if $wigsum.wigsum_type
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
30 -t $wigsum.totalwig
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
31 #end if
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
32
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
33 #if $skipmultihits
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
34 -u
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
35 #end if
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
36 </command>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
37 <inputs>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
38 <param name="input" type="data" label="Input .bam File" format="bam" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
39 <param name="chromsize" type="data" label="Chromosome size file (tab or space separated)" format="txt,tabular" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
40 <param name="skipmultihits" type="boolean" label="Skip Multiple Hit Reads/Only Use Uniquely Mapped Reads" value="false" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
41 <conditional name="wigsum">
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
42 <param name="wigsum_type" type="boolean" label="Specify wigsum?" value="false">
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
43 </param>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
44 <when value="true">
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
45 <param name="totalwig" value="0" type="integer" label="specified wigsum" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
46 </when>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
47 <when value="false"></when>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
48 </conditional>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
49 <conditional name="strand_type">
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
50 <param name="strand_specific" type="select" label="Strand-specific?" value="none">
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
51 <option value="none">none</option>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
52 <option value="pair">Pair-End RNA-seq</option>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
53 <option value="single">Single-End RNA-seq</option>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
54 </param>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
55 <when value="pair">
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
56 <param name="pair_type" type="select" display="radio" label="Pair-End Read Type (format: mapped --> parent)" value="sd">
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
57 <option value="sd"> read1 (positive --> positive; negative --> negative), read2 (positive --> negative; negative --> positive)</option>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
58 <option value="ds">read1 (positive --> negative; negative --> positive), read2 (positive --> positive; negative --> negative)</option>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
59 </param>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
60 </when>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
61 <when value="single">
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
62 <param name="single_type" type="select" display="radio" label="Single-End Read Type (format: mapped --> parent)" value="s">
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
63 <option value="s">positive --> positive; negative --> negative</option>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
64 <option value="d">positive --> negative; negative --> positive</option>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
65 </param>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
66 </when>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
67 <when value="none"></when>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
68 </conditional>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
69 </inputs>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
70 <outputs>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
71 <data format="wig" name="output" from_work_dir="outfile.wig">
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
72 <filter>strand_type['strand_specific'] == 'none'</filter>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
73 </data>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
74 <data format="wig" name="outputfwd" from_work_dir="outfile_Forward.wig">
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
75 <filter>strand_type['strand_specific'] != 'none'</filter>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
76 </data>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
77 <data format="wig" name="outputrv" from_work_dir="outfile_Reverse.wig">
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
78 <filter>strand_type['strand_specific'] != 'none'</filter>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
79 </data>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
80 </outputs>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
81 <tests>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
82 <test>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
83 <param name="input" value="Pairend_nonStrandSpecific_36mer_Human_hg19.bam" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
84 <param name="chromsize" value="sample.hg19.chrom.sizes.txt" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
85 <param name="skipmultihits" value="false" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
86 <param name="wigsum.wigsum_type" value="false" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
87 <param name="strand_type.strand_specific" value="none" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
88 <output name="output" file="outfile.wig" />
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
89 </test>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
90 </tests>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
91 <help>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
92 .. image:: https://code.google.com/p/rseqc/logo?cct=1336721062
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
93
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
94 -----
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
95
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
96 About RSeQC
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
97 +++++++++++
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
98
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
99 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.
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
100
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
101 The RSeQC package is licensed under the GNU GPL v3 license.
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
102
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
103 Inputs
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
104 ++++++++++++++
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
105
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
106 Input BAM file
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
107 Alignment file in BAM format (SAM is not supported). BAM file will be sorted and indexed using samTools.
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
108
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
109 Chromosome size file
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
110 Tab or space separated text file with 2 columns: first column is chromosome name, second column is size of the chromosome. Chromosome names (such as "chr1") should be consistent between this file and BAM file.
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
111
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
112 Specified wigsum (default=none)
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
113 Specified wigsum. Wigsum of 100000000 equals to coverage achieved by 1 million 100nt reads. Ignore this option to disable normalization.
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
114
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
115 Skip multiple Hit reads
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
116 skips multiple hit reads or only use uniquely mapped reads
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
117
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
118 Strand-specific (default=none)
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
119 How read(s) were stranded during sequencing. If you are not sure about the strand rule, run infer_experiment.py
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
120
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
121 Outputs
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
122 ++++++++++++++
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
123
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
124 If RNA-seq is not strand specific, one wig file will be generated, if RNA-seq
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
125 is strand specific, two wig files corresponding to Forward and Reverse will be generated.
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
126
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
127
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
128 </help>
dc3b3b88fbab first commit
nilesh
parents:
diff changeset
129 </tool>