annotate bam2wig.xml @ 3:49ed5952a8b8 draft

Uploaded
author lparsons
date Fri, 26 Sep 2014 14:53:50 -0400
parents
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_bam2wig" name="BAM to Wiggle" version="2.4">
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
2 <description>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
3 converts all types of RNA-seq data from .bam to .wig
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 tmp_input_name=\$(mktemp -u);
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
12 bai='.bai';
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
13
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
14 ln -s "${input}" \$tmp_input_name &amp;&amp;
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
15 ln -s "${input.metadata.bam_index}" \$tmp_input_name\$bai &amp;&amp;
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
16 bam2wig.py -i \$tmp_input_name -s $chromsize -o outfile
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
17
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
18 #if str($strand_type.strand_specific) == "pair"
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
19 -d
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
20 #if str($strand_type.pair_type) == "sd"
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
21 '1++,1--,2+-,2-+'
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
22 #else
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
23 '1+-,1-+,2++,2--'
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
24 #end if
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
25 #end if
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
26
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
27 #if str($strand_type.strand_specific) == "single"
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
28 -d
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
29 #if str($strand_type.single_type) == "s"
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
30 '++,--'
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
31 #else
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
32 '+-,-+'
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
33 #end if
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
34 #end if
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
35
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
36 #if $wigsum.wigsum_type
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
37 -t $wigsum.totalwig
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
38 #end if
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
39
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
40 #if $skipmultihits
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
41 -u
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
42 #end if
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
43 ;
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
44 rm "\$tmp_input_name\$bai";
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
45 rm \$tmp_input_name
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
46 </command>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
47 <inputs>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
48 <param name="input" type="data" label="Input .bam File" format="bam" />
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
49 <param name="chromsize" type="data" label="Chromosome size file (tab or space separated)" format="txt,tabular" />
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
50 <param name="skipmultihits" type="boolean" label="Skip Multiple Hit Reads/Only Use Uniquely Mapped Reads" value="false" />
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
51 <conditional name="wigsum">
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
52 <param name="wigsum_type" type="boolean" label="Specify wigsum?" value="false">
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
53 </param>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
54 <when value="true">
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
55 <param name="totalwig" value="0" type="integer" label="specified wigsum" />
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
56 </when>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
57 <when value="false"/>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
58 </conditional>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
59 <conditional name="strand_type">
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
60 <param name="strand_specific" type="select" label="Strand-specific?" value="none">
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
61 <option value="none">none</option>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
62 <option value="pair">Pair-End RNA-seq</option>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
63 <option value="single">Single-End RNA-seq</option>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
64 </param>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
65 <when value="pair">
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
66 <param name="pair_type" type="select" display="radio" label="Pair-End Read Type (format: mapped --> parent)" value="sd">
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
67 <option value="sd"> read1 (positive --> positive; negative --> negative), read2 (positive --> negative; negative --> positive)</option>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
68 <option value="ds">read1 (positive --> negative; negative --> positive), read2 (positive --> positive; negative --> negative)</option>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
69 </param>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
70 </when>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
71 <when value="single">
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
72 <param name="single_type" type="select" display="radio" label="Single-End Read Type (format: mapped --> parent)" value="s">
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
73 <option value="s">positive --> positive; negative --> negative</option>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
74 <option value="d">positive --> negative; negative --> positive</option>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
75 </param>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
76 </when>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
77 <when value="none"></when>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
78 </conditional>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
79 </inputs>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
80 <outputs>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
81 <data format="wig" name="output" from_work_dir="outfile.wig">
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
82 <filter>strand_type['strand_specific'] == 'none'</filter>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
83 </data>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
84 <data format="wig" name="outputfwd" from_work_dir="outfile_Forward.wig" label="${tool.name} on ${on_string} (Forward Reads)">
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
85 <filter>strand_type['strand_specific'] != 'none'</filter>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
86 </data>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
87 <data format="wig" name="outputrv" from_work_dir="outfile_Reverse.wig" label="${tool.name} on ${on_string} (Reverse Reads)">
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
88 <filter>strand_type['strand_specific'] != 'none'</filter>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
89 </data>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
90 </outputs>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
91 <stdio>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
92 <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
93 <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
94 </stdio>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
95 <help>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
96 bam2wig.py
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
97 ++++++++++
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
98
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
99 Visualization is the most straightforward and effective way to QC your RNA-seq
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
100 data. For example, change of expression or new splicing can be easily checked
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
101 by visually comparing two RNA-seq tracks using genome browser such as UCSC_,
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
102 IGB_ and IGV_. `bam2wig.py` converts all types of RNA-seq data from BAM_
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
103 format into wiggle_ format in one-stop. wiggle_ files can then be easily
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
104 converted into bigwig_. Bigwig is indexed, binary format of wiggle file, and
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
105 it's particular useful to display large, continuous dataset on genome
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
106 browser.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
107
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
108 Inputs
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
109 ++++++++++++++
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
110
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
111 Input BAM file
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
112 Alignment file in BAM format (SAM is not supported). BAM file will be sorted and indexed using samTools.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
113
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
114 Chromosome size file
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
115 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.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
116
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
117 Specified wigsum (default=none)
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
118 Specified wigsum. Wigsum of 100000000 equals to coverage achieved by 1 million 100nt reads. Ignore this option to disable normalization.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
119
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
120 Skip multiple Hit reads
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
121 skips multiple hit reads or only use uniquely mapped reads
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
122
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
123 Strand-specific (default=none)
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
124 How read(s) were stranded during sequencing. If you are not sure about the strand rule, run infer_experiment.py
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
125
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
126 Outputs
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
127 ++++++++++++++
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
128
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
129 If RNA-seq is not strand specific, one wig file will be generated, if RNA-seq
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
130 is strand specific, two wig files corresponding to Forward and Reverse will be generated.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
131
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
132 -----
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
133
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
134 About RSeQC
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
135 +++++++++++
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
136
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
137
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
138 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
139
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
140 The RSeQC package is licensed under the GNU GPL v3 license.
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
141
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
142 .. image:: http://rseqc.sourceforge.net/_static/logo.png
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
143
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
144 .. _RSeQC: http://rseqc.sourceforge.net/
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
145 .. _UCSC: http://genome.ucsc.edu/index.html
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
146 .. _IGB: http://bioviz.org/igb/
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
147 .. _IGV: http://www.broadinstitute.org/igv/home
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
148 .. _BAM: http://genome.ucsc.edu/goldenPath/help/bam.html
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
149 .. _wiggle: http://genome.ucsc.edu/goldenPath/help/wiggle.html
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
150 .. _bigwig: http://genome.ucsc.edu/FAQ/FAQformat.html#format6.1
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
151
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
152 </help>
49ed5952a8b8 Uploaded
lparsons
parents:
diff changeset
153 </tool>