annotate bam2wig.xml @ 5:31a43978eaa9 draft default tip

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