annotate ccat_wrapper.xml @ 20:6faad38a1a88 draft default tip

Uploaded
author jbrayet
date Thu, 21 Jan 2016 11:05:37 -0500
parents 4d554ba698eb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
1 <tool id="peakcalling_ccat" name="CCAT" version="0.1">
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
2 <description>Control-based ChIP-seq Analysis Tool</description>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
3 <requirements>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
4 <container type="docker">institutcuriengsintegration/ccat:1.0</container>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
5 </requirements>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
6 <command interpreter="python">ccat_wrapper.py '$input_tag_file' '$input_control_file' '$genome'
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
7 #if str( $options_type[ 'options_type_selector' ] ) == 'advanced':
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
8 '$input_advanced_config_file'
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
9 #else:
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
10 $options_type[ 'input_config_file' ]
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
11 #end if
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
12 'CCAT'
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
13 '$output_peak_file' '$output_region_file' '$output_top_file' '$output_log_file' '${__root_dir__}'</command>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
14 <inputs>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
15 <param name="input_tag_file" type="data" format="bed" label="ChIP-Seq Tag File" />
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
16 <param name="input_control_file" type="data" format="bed" label="ChIP-Seq Control File" />
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
17 <param name="genome" type="select" label="Genome" >
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
18 <option value="hg19" selected="True">Human (hg19)</option>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
19 <option value="mm10" >Mouse (mm10)</option>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
20 <option value="hg18" >Human (hg18)</option>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
21 <option value="mm9" >Mouse (mm9)</option>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
22 </param>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
23 <conditional name="options_type">
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
24 <param name="options_type_selector" type="select" label="Advanced Options">
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
25 <option value="basic" selected="True">Hide Advanced Options and select configuration file</option>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
26 <option value="advanced">Show Advanced Options</option>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
27 </param>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
28 <when value="basic">
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
29 <param name="input_config_file" type="data" format="txt" label="Select a pre-defined configuration file" />
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
30 </when>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
31 <when value="advanced">
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
32 <param name="fragment_size" type="integer" label="Length of DNA fragment" value="200"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
33 <param name="sliding_window_size" type="integer" label="Sliding window size" value="500" help="transcription factor binding default: 300; histone modifications default: 500"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
34 <param name="moving_step" type="integer" label="Step of sliding window" value="50" help="transcription factor binding default: 10; histone modifications default: 50"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
35 <param name="is_strand_sensitive_mode" type="select" label="isStrandSensitiveMode" >
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
36 <option value="1">Transition from sense strand to anti-sense strand</option>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
37 <option value="0" selected="True">Local maximum of read-enrichment profile</option>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
38 </param>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
39 <param name="min_count" type="integer" label="Minimum number of read counts at the peak" value="4"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
40 <param name="output_num" type="integer" label="Number of peaks reported in top peak file" value="100000"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
41 <param name="random_seed" type="integer" label="Random Seed" value="123456"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
42 <param name="min_score" type="float" label="Minimum score of normalized difference" value="3.0"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
43 <param name="bootstrap_pass" type="integer" label="Number of passes in the bootstrapping process" value="50"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
44 </when>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
45 </conditional>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
46 </inputs>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
47 <outputs>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
48 <data name="output_peak_file" format="interval" label="${tool.name} on ${on_string} (peaks)">
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
49 <actions>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
50 <action type="metadata" name="chromCol" default="1"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
51 <action type="metadata" name="startCol" default="3"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
52 <action type="metadata" name="endCol" default="4"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
53 </actions>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
54 </data>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
55 <data name="output_region_file" format="interval" label="${tool.name} on ${on_string} (regions)">
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
56 <actions>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
57 <action type="metadata" name="chromCol" default="1"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
58 <action type="metadata" name="startCol" default="3"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
59 <action type="metadata" name="endCol" default="4"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
60 </actions>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
61 </data>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
62 <data name="output_top_file" format="interval" label="${tool.name} on ${on_string} (top peaks)">
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
63 <actions>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
64 <action type="metadata" name="chromCol" default="1"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
65 <action type="metadata" name="startCol" default="3"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
66 <action type="metadata" name="endCol" default="4"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
67 </actions>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
68 </data>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
69 <data name="output_log_file" format="txt" label="${tool.name} on ${on_string} (log)"/>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
70 </outputs>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
71 <configfiles>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
72 <configfile name="input_advanced_config_file">#if str( $options_type['options_type_selector' ] ) == 'advanced':
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
73 fragmentSize ${options_type[ 'fragment_size' ]}
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
74 slidingWinSize ${options_type[ 'sliding_window_size' ]}
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
75 movingStep ${options_type[ 'moving_step' ]}
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
76 isStrandSensitiveMode ${options_type[ 'is_strand_sensitive_mode' ]}
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
77 minCount ${options_type[ 'min_count' ]}
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
78 outputNum ${options_type[ 'output_num' ]}
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
79 randomSeed ${options_type[ 'random_seed' ]}
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
80 minScore ${options_type[ 'min_score' ]}
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
81 bootstrapPass ${options_type[ 'bootstrap_pass' ]}
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
82 #end if</configfile>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
83 </configfiles>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
84 <help>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
85 **What it does**
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
86
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
87 This tool allows ChIP-seq peak/region calling using CCAT.
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
88
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
89 View the original CCAT `documentation. &lt;http://cmb.gis.a-star.edu.sg/ChIPSeq/paperCCAT.html&gt;`_
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
90
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
91 ------
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
92
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
93 **Citation**
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
94
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
95 For the underlying tool, please cite `Xu H, Handoko L, Wei X, Ye C, Sheng J, Wei CL, Lin F, Sung WK. A signal-noise model for significance analysis of ChIP-seq with negative control. Bioinformatics. 2010 May 1;26(9):1199-204. &lt;http://www.ncbi.nlm.nih.gov/pubmed/20371496&gt;`_
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
96
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
97 If you use this tool in Galaxy, please cite Blankenberg D, et al. *In preparation.*
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
98
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
99 </help>
4d554ba698eb Uploaded
jbrayet
parents:
diff changeset
100 </tool>