annotate annotatePeaks_wrapper.xml @ 21:6f794643f7cd draft default tip

planemo upload
author oinizan
date Wed, 25 May 2016 09:43:12 -0400
parents 9f656b0bfe88
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
1 <!--annotatePeaks - developed by Jocelyn Brayet <jocelyn.brayet@curie.fr>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
2 Copyright (C) 2015 Institut Curie
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
3
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
4 This program is free software: you can redistribute it and/or modify
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
5 it under the terms of the GNU General Public License as published by
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
6 the Free Software Foundation, either version 3 of the License, or
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
7 (at your option) any later version.
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
8
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
9 This program is distributed in the hope that it will be useful,
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
12 GNU General Public License for more details.
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
13
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
14 You should have received a copy of the GNU General Public License
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
15 along with this program. If not, see <http://www.gnu.org/licenses/>.-->
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
16 <tool id="annotatePeaks" name="AnnotatePeaks" version="1.0">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
17 <description>Genomic annotation of Chip-Seq peaks</description>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
18 <requirements>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
19 <requirement type="package" version="2.11.1">fontconfig</requirement>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
20 <requirement type="package" version="3.1.2">R</requirement>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
21 </requirements>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
22 <command interpreter="bash">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
23 #if str( $if_PDF ) == '0' and $use_reg.use_reg_selector == "no" and $use_control.use_control_selector == "no" #annotatePeaks_wrapper.sh -f $inputfile -y $log -m $minScore -l $left -o $outputPNG -r $right -d $DownGene -h $EnhLeft -u $stats -v $input_organism.version -p 0 #elif str( $if_PDF ) == '0' and $use_reg.use_reg_selector == "no" and $use_control.use_control_selector == "yes" # annotatePeaks_wrapper.sh -f $inputfile -y $log -c $controlfile -x $statsControl -o $outputPNG -m $minScore -l $left -r $right -d $DownGene -h $EnhLeft -u $stats -v $input_organism.version -p 0 #elif str( $if_PDF ) == '0' and $use_reg.use_reg_selector == "yes" and $use_control.use_control_selector == "no" # annotatePeaks_wrapper.sh -y $log -f $inputfile -e $regfile -m $minScore -l $left -o $outputPNG -r $right -d $DownGene -h $EnhLeft -u $stats -v $input_organism.version -p 0 #elif str( $if_PDF ) == '0' and $use_reg.use_reg_selector == "yes" and $use_control.use_control_selector == "yes" # annotatePeaks_wrapper.sh -f $inputfile -c $controlfile -x $statsControl -l $left -y $log -o $outputPNG -m $minScore -r $right -d $DownGene -h $EnhLeft -u $stats -v $input_organism.version -e $regfile -p 0 #elif str( $if_PDF ) == '1' and $use_reg.use_reg_selector == "no" and $use_control.use_control_selector == "no" #annotatePeaks_wrapper.sh -f $inputfile -y $log -m $minScore -l $left -o $outputPDF -r $right -d $DownGene -h $EnhLeft -u $stats -v $input_organism.version -p 1 #elif str( $if_PDF ) == '1' and $use_reg.use_reg_selector == "no" and $use_control.use_control_selector == "yes" # annotatePeaks_wrapper.sh -f $inputfile -y $log -c $controlfile -x $statsControl -o $outputPDF -m $minScore -l $left -r $right -d $DownGene -h $EnhLeft -u $stats -v $input_organism.version -p 1 #elif str( $if_PDF ) == '1' and $use_reg.use_reg_selector == "yes" and $use_control.use_control_selector == "no" # annotatePeaks_wrapper.sh -y $log -f $inputfile -e $regfile -m $minScore -l $left -o $outputPDF -r $right -d $DownGene -h $EnhLeft -u $stats -v $input_organism.version -p 1 #elif str( $if_PDF ) == '1' and $use_reg.use_reg_selector == "yes" and $use_control.use_control_selector == "yes" # annotatePeaks_wrapper.sh -f $inputfile -c $controlfile -x $statsControl -l $left -y $log -o $outputPDF -m $minScore -r $right -d $DownGene -h $EnhLeft -u $stats -v $input_organism.version -e $regfile -p 1#end if
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
24 </command>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
25 <inputs>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
26
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
27 <param name="inputfile" type="data" label="ChIP peaks" value="ChIP peaks File" format="bed"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
28 <param name="minScore" type="float" label="MinimalScore" value="0" help="Set to 0 if you don't want to filter your .BED file with peaks"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
29
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
30 <conditional name="use_control">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
31 <param name="use_control_selector" type="select" label="Use control data">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
32 <option value="no" selected="true">No</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
33 <option value="yes">Yes</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
34 </param>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
35 <when value="yes">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
36 <param name="controlfile" type="data" label="Control peaks" value="Control peaks File" format="bed"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
37 </when>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
38 </conditional>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
39
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
40 <param name="left" type="integer" label="Define Promoter is a region up to X bp upstream gene TSS" value="-2000"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
41 <param name="right" type="integer" label="Define Immediate Downstream is a region up to X bp downstream gene TSS" value="2000"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
42 <param name="EnhLeft" type="integer" label="Define Enhancer is a region up to X bp upstream gene TSS" value="-30000"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
43 <param name="DownGene" type="integer" label="Define Gene Downstream is a region up to X bp downstream transcription end" value="5000"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
44
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
45
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
46 <conditional name="input_organism">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
47 <param name="input_organism_selector" type="select" label="Select organism">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
48 <option value="Human" selected="true">Homo sapiens</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
49 <option value="Mouse">Mus musculus</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
50 <option value="Zebrafish">Zebrafish (Danio rerio)</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
51 <option value="XTropicalis">X.Tropicalis</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
52 <option value="Bacteria/MycoTube">M. tuberculosis</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
53 </param>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
54 <when value="Human">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
55 <param name="version" type="select" label="Select genome vesion">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
56 <option value="hg19" selected="true">hg19</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
57 <option value="hg18">hg18</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
58 </param>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
59 </when>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
60 <when value="Mouse">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
61 <param name="version" type="select" label="Select genome vesion">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
62 <option value="mm8" >mm8</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
63 <option value="mm9" selected="true">mm9</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
64 <option value="mm10" >mm10</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
65 </param>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
66 </when>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
67 <when value="Zebrafish">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
68 <param name="version" type="select" label="Select genome vesion">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
69 <option value="zv9" selected="true">zv9</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
70 </param>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
71 </when>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
72 <when value="XTropicalis">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
73 <param name="version" type="select" label="Select genome vesion">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
74 <option value="xenTro2" >xenTro2</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
75 <option value="xenTro3" selected="true">xenTro3</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
76 </param>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
77 </when>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
78 <when value="Bacteria/MycoTube">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
79 <param name="version" type="select" label="Select genome vesion">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
80 <option value="H37Rv" selected="true">H37Rv</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
81 </param>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
82 </when>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
83 </conditional>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
84
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
85 <conditional name="use_reg">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
86 <param name="use_reg_selector" type="select" label="Use transcriptomic data (up- and down- regulated genes)">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
87 <option value="no" selected="true">No</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
88 <option value="yes">Yes</option>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
89 </param>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
90 <when value="yes">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
91 <param name="regfile" type="data" label="File with information about gene regulation" value="Regulation data" format="txt"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
92 </when>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
93 </conditional>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
94
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
95 <param name="if_PDF" type="boolean" label="Do you want to have a PDF image (default PNG)?" truevalue="1" falsevalue="0" checked="False"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
96 </inputs>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
97 <outputs>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
98 <data name="outputPNG" format="png" label="Peaks Stats (png)">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
99 <filter>(if_PDF == 0)</filter>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
100 </data>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
101 <data name="outputPDF" format="pdf" label="Peaks Stats (pdf)">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
102 <filter>(if_PDF == True)</filter>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
103 </data>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
104
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
105 <data name="stats" format="tabular" label="Annotated Peaks (ChIP)"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
106 <data name="log" format="log" label=".LOG for Annotated Peaks"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
107 <data name="statsControl" format="tabular" label="Annotated Peaks (Control)">
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
108 <filter>(use_control['use_control_selector'] == 'yes')</filter>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
109 </data>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
110 </outputs>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
111 <tests>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
112 <test>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
113 <param name="inputfile" value="peaks_test.bed"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
114 <param name="minScore" value="0.0"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
115 <param name="use_control_selector" value="yes"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
116 <param name="controlfile" value="peaks_control.bed"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
117 <param name="left" value="-2000"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
118 <param name="right" value="2000"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
119 <param name="EnhLeft" value="-30000"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
120 <param name="DownGene" value="5000"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
121 <param name="input_organism_selector" value="Mouse"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
122 <param name="version" value="mm9"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
123 <param name="use_reg_selector" value="yes"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
124 <param name="regfile" value="Probesets_FC1.5_10022011.txt"/>
21
6f794643f7cd planemo upload
oinizan
parents: 0
diff changeset
125 <param name="if_PDF" value="0"/>
6f794643f7cd planemo upload
oinizan
parents: 0
diff changeset
126 <output name="outputPNG" file="test_annotatePeaks_1.dat" ftype="png"/>
0
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
127 <output name="stats" file="test_annotatePeaks_2.dat" ftype="tabular"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
128 <output name="log" file="test_annotatePeaks_3.dat" ftype="log"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
129 <output name="statsControl" file="test_annotatePeaks_4.dat" ftype="tabular"/>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
130 </test>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
131 </tests>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
132 <help>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
133 **What it does**
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
134
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
135 This tool annotates peaks with genomic feature (promoter, enhancer, exon, intron, etc.) and creates a .png file with distribution
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
136
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
137 </help>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
138 <citations>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
139 <citation type="bibtex">@article{Boeva01102012,
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
140 author = {Boeva, Valentina and Lermine, Alban and Barette, Camille and Guillouf, Christel and Barillot, Emmanuel},
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
141 title = {Nebula—a web-server for advanced ChIP-seq data analysis},
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
142 volume = {28},
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
143 number = {19},
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
144 pages = {2517-2519},
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
145 year = {2012},
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
146 doi = {10.1093/bioinformatics/bts463},
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
147 URL = {http://bioinformatics.oxfordjournals.org/content/28/19/2517.abstract},
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
148 eprint = {http://bioinformatics.oxfordjournals.org/content/28/19/2517.full.pdf+html},
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
149 journal = {Bioinformatics}
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
150 }</citation>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
151 </citations>
9f656b0bfe88 Uploaded
jbrayet
parents:
diff changeset
152 </tool>