annotate ideas.xml @ 28:91dc2a532890 draft

Uploaded
author greg
date Mon, 14 Aug 2017 09:06:15 -0400
parents 0cf199863400
children 06522a4aae6d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
d75cbb2db2c4 Uploaded
greg
parents: 0
diff changeset
1 <tool id="ideas" name="IDEAS" version="1.2.0">
0
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
2 <description>accounts for position dependent epigenetic events and detects local cell type relationships</description>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
3 <requirements>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
4 <requirement type="package" version="2.26.0">bedtools</requirement>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
5 <requirement type="package" version="332">ucsc-bedgraphtobigwig</requirement>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
6 <requirement type="package" version="332">ucsc-bedsort</requirement>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
7 <requirement type="package" version="332">ucsc-bigwigaverageoverbed</requirement>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
8 <requirement type="package" version="1.2.0">ideas</requirement>
20
a70690dcf9ff Uploaded
greg
parents: 14
diff changeset
9 <requirement type="package" version="1.3.2">r-optparse</requirement>
0
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
10 </requirements>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
11 <command><![CDATA[
3
9874800487e6 Uploaded
greg
parents: 1
diff changeset
12 #import os
12
5b5733e09344 Uploaded
greg
parents: 11
diff changeset
13 #set tmp_dir = 'tmp'
25
0169856fe7bb Uploaded
greg
parents: 24
diff changeset
14 #set prep_output_config = 'prep_output_config.txt'
27
0cf199863400 Uploaded
greg
parents: 26
diff changeset
15 ##set ideas_input_dir = 'ideas_input'
0cf199863400 Uploaded
greg
parents: 26
diff changeset
16 ##set ideas_matrix_input_file = $os.path.join($ideas_input_dir, 'r_matrix.txt')
0cf199863400 Uploaded
greg
parents: 26
diff changeset
17 ##mkdir -p $ideas_input_dir &&
3
9874800487e6 Uploaded
greg
parents: 1
diff changeset
18 ##############################################
0
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
19 ## Create the config file and prepare the data
3
9874800487e6 Uploaded
greg
parents: 1
diff changeset
20 ##############################################
0
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
21 #set input_type = $input_type_cond.input_type
25
0169856fe7bb Uploaded
greg
parents: 24
diff changeset
22 cp '$prep_input_config' 'prep_input_config.txt' &&
0
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
23 prepMat
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
24 #if str($input_type) == 'datasets':
25
0169856fe7bb Uploaded
greg
parents: 24
diff changeset
25 '$prep_input_config'
0
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
26 #set specify_genomic_window_cond = $input_type_cond.specify_genomic_window_cond
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
27 #set specify_genomic_window = $specify_genomic_window_cond.specify_genomic_window
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
28 #if str($specify_genomic_window) == 'yes':
23
64c372086d41 Uploaded
greg
parents: 20
diff changeset
29 -bed '$bed_input'
0
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
30 #else:
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
31 -gsz '$chromInfo'
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
32 -wsz $specify_genomic_window_cond.window_size
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
33 #set restrict_chromosomes = $specify_genomic_window_cond.restrict_chromosomes_cond.restrict_chromosomes
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
34 #if str($restrict_chromosomes) == 'yes':
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
35 #set chroms = []
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
36 #set chrom_repeat = $specify_genomic_window_cond.restrict_chromosomes_cond.chrom_repeat
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
37 #for $i in $chrom_repeat.chrom
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
38 $chroms.append($i)
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
39 #end for
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
40 -chr ",".join(chroms)
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
41 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
42 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
43 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
44 #set outputs_by_chr = $outputs_by_chr_cond.outputs_by_chr
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
45 #if str($outputs_by_chr) == 'yes':
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
46 -bychr
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
47 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
48 -c $reads_per_bp
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
49 #set blacklist_regions = $blacklist_regions_cond.blacklist_regions
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
50 #if str($blacklist_regions) == 'yes':
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
51 -exclude '$blacklist_regions_cond.blacklist_input'
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
52 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
53 #set standardize_datasets = $standardize_datasets_cond.standardize_datasets
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
54 #if str($standardize_datasets) == 'yes':
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
55 -norm
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
56 #end if
3
9874800487e6 Uploaded
greg
parents: 1
diff changeset
57 ##############################################
26
53891e4e4c63 Uploaded
greg
parents: 25
diff changeset
58 ## Conform the prepMat config output to the
53891e4e4c63 Uploaded
greg
parents: 25
diff changeset
59 ## format expected by the R matrix builder.
53891e4e4c63 Uploaded
greg
parents: 25
diff changeset
60 ##############################################
53891e4e4c63 Uploaded
greg
parents: 25
diff changeset
61 && cut -d' ' $prep_input_config -f1,2 > file1.txt
53891e4e4c63 Uploaded
greg
parents: 25
diff changeset
62 && ls -p tmp/ | grep ".bed.gz" > file2.txt
53891e4e4c63 Uploaded
greg
parents: 25
diff changeset
63 && paste <(cat file1.txt) <(cat file2.txt) > $prep_output_config
53891e4e4c63 Uploaded
greg
parents: 25
diff changeset
64 ##############################################
3
9874800487e6 Uploaded
greg
parents: 1
diff changeset
65 ## Build the R matrix from the prepMat output
9874800487e6 Uploaded
greg
parents: 1
diff changeset
66 ##############################################
25
0169856fe7bb Uploaded
greg
parents: 24
diff changeset
67 ##&& Rscript '$__tool_directory__/build_matrix.R'
0169856fe7bb Uploaded
greg
parents: 24
diff changeset
68 ##-i $tmp_dir/*.bed.gz
0169856fe7bb Uploaded
greg
parents: 24
diff changeset
69 ##-o $ideas_matrix_input_file
0169856fe7bb Uploaded
greg
parents: 24
diff changeset
70 ##-w $ideas_input_dir
3
9874800487e6 Uploaded
greg
parents: 1
diff changeset
71 ##############################################
9874800487e6 Uploaded
greg
parents: 1
diff changeset
72 ## Run IDEAS on the R matrix
9874800487e6 Uploaded
greg
parents: 1
diff changeset
73 ##############################################
0
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
74 && ideas
25
0169856fe7bb Uploaded
greg
parents: 24
diff changeset
75 '$prep_output_config'
26
53891e4e4c63 Uploaded
greg
parents: 25
diff changeset
76 $tmp_dir/*.bed
0
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
77 #set smoother_annotation = $smoother_annotation_cond.smoother_annotation
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
78 #if str($smoother_annotation) == 'yes':
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
79 -hp
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
80 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
81 #set smoother_annotation = $smoother_annotation_cond.smoother_annotation
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
82 #if str($smoother_annotation) == 'yes':
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
83 -hp
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
84 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
85 #set in_windows = $in_windows_cond.in_windows
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
86 #if str($in_windows) == 'yes':
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
87 -inv $window_start $window_end
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
88 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
89 #set log2_transformation = $log2_transformation_cond.log2_transformation
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
90 #if str($log2_transformation) == 'yes':
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
91 #set log2_num = $log2_transformation.log2_num
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
92 -log2
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
93 #if str($log2_num) != '0':
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
94 $log2_num
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
95 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
96 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
97 #set max_states_inferred = $max_states_inferred_cond.max_states_inferred
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
98 #if str($max_states_inferred) == 'yes':
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
99 -G $max_states_inferred_cond.max_states
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
100 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
101 #set num_initial_states = $num_initial_states_cond.num_initial_states
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
102 #if str($num_initial_states) == 'yes':
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
103 -C $num_initial_states_cond.initial_states
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
104 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
105 #if str($max_position_classes) != '0':
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
106 -P $max_position_classes
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
107 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
108 #if str($max_cell_type_clusters) != '0':
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
109 -K $max_cell_type_clusters
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
110 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
111 #if str($prior_concentration) != '0':
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
112 -A $prior_concentration
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
113 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
114 #set burnin_max_steps = $burnin_max_steps_cond.burnin_max_steps
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
115 #if str($burnin_max_steps) == 'yes':
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
116 -sample $burnin_max_steps_cond.burnin_num $burnin_max_steps_cond.mcmc_num
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
117 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
118 #set set_min_standard_dev = $set_min_standard_dev_cond.set_min_standard_dev
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
119 #if str($set_min_standard_dev) == 'yes':
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
120 -minerr $set_min_standard_dev_cond.min_standard_dev
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
121 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
122 #set set_max_standard_dev = $set_max_standard_dev_cond.set_max_standard_dev
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
123 #if str($set_max_standard_dev) == 'yes':
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
124 -maxerr $set_max_standard_dev_cond.max_standard_dev
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
125 #end if
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
126 -thread \${GALAXY_SLOTS:-4}
28
91dc2a532890 Uploaded
greg
parents: 27
diff changeset
127 > $output_log
27
0cf199863400 Uploaded
greg
parents: 26
diff changeset
128 && mv *.cluster $output_cluster
0cf199863400 Uploaded
greg
parents: 26
diff changeset
129 && mv *.para $output_para
0cf199863400 Uploaded
greg
parents: 26
diff changeset
130 && mv *.profile $output_profile
0cf199863400 Uploaded
greg
parents: 26
diff changeset
131 && mv *.state $output_state
0
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
132 ]]></command>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
133 <configfiles>
25
0169856fe7bb Uploaded
greg
parents: 24
diff changeset
134 <configfile name="prep_input_config"><![CDATA[#for $input_items in $input_type_cond.input_repeat:
0
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
135 ${input_items.cell_type_name} ${input_items.epigenetic_factor_name} ${input_items.input}
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
136 #end for ]]></configfile>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
137 </configfiles>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
138 <inputs>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
139 <conditional name="input_type_cond">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
140 <param name="input_type" type="select" label="Select input type">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
141 <option value="datasets" selected="true">Bam, BigWig files</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
142 <option value="data_matrix">Data matrix</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
143 </param>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
144 <when value="datasets">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
145 <repeat name="input_repeat" title="Cell type, Epigenetic factor and Input" min="1">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
146 <param name="cell_type_name" type="text" value="" label="Cell type name"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
147 <param name="epigenetic_factor_name" type="text" value="" label="Epigenetic factor name"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
148 <param name="input" type="data" format="bigwig,bam" label="BAM or BigWig file">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
149 <validator type="unspecified_build"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
150 </param>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
151 </repeat>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
152 <conditional name="specify_genomic_window_cond">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
153 <param name="specify_genomic_window" type="select" label="Select Bed file that defines genomic windows on which to process the data">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
154 <option value="no" selected="true">No</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
155 <option value="yes">Yes</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
156 </param>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
157 <when value="no">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
158 <param name="window_size" type="integer" value="200" label="Window size in base pairs"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
159 <conditional name="restrict_chromosomes_cond">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
160 <param name="restrict_chromosomes" type="select" label="Restrict processing to specified chromosomes">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
161 <option value="no" selected="true">No</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
162 <option value="yes">Yes</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
163 </param>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
164 <when value="no"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
165 <when value="yes">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
166 <repeat name="chrom_repeat" title="Chromosomes" min="1">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
167 <param name="chrom" type="text" value="" label="Chromosome"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
168 </repeat>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
169 </when>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
170 </conditional>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
171 </when>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
172 <when value="yes">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
173 <param name="bed_input" type="data" format="bed" label="Bed file specifying the genomic windows"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
174 </when>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
175 </conditional>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
176 </when>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
177 <when value="data_matrix"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
178 </conditional>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
179 <conditional name="outputs_by_chr_cond">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
180 <param name="outputs_by_chr" type="select" display="radio" label="Output chromosomes in seperate files">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
181 <option value="no" selected="true">No</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
182 <option value="yes">Yes</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
183 </param>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
184 <when value="no"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
185 <when value="yes"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
186 </conditional>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
187 <param name="reads_per_bp" type="integer" value="1" min="1" max="8" label="Number of reads per base pair for calculating the average signal in each genomic window"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
188 <conditional name="blacklist_regions_cond">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
189 <param name="blacklist_regions" type="select" label="Select Bed file containing blacklist regions for exclusion">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
190 <option value="no" selected="true">No</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
191 <option value="yes">Yes</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
192 </param>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
193 <when value="no"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
194 <when value="yes">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
195 <param name="blacklist_input" type="data" format="bed" label="Bed file containing regions to exclude"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
196 </when>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
197 </conditional>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
198 <conditional name="standardize_datasets_cond">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
199 <param name="standardize_datasets" type="select" display="radio" label="Standardize all datasets">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
200 <option value="no" selected="true">No</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
201 <option value="yes">Yes</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
202 </param>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
203 <when value="no"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
204 <when value="yes"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
205 </conditional>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
206 <conditional name="smoother_annotation_cond">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
207 <param name="smoother_annotation" type="select" display="radio" label="Discourage state transition across chromosomes">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
208 <option value="no" selected="true">No</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
209 <option value="yes">Yes</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
210 </param>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
211 <when value="no"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
212 <when value="yes"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
213 </conditional>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
214 <conditional name="in_windows_cond">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
215 <param name="in_windows" type="select" display="radio" label="Run IDEAS only within defined windows in the input data">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
216 <option value="no" selected="true">No</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
217 <option value="yes">Yes</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
218 </param>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
219 <when value="no"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
220 <when value="yes">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
221 <param name="window_start" type="integer" value="0" min="0" label="Window start" help="Zero-based"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
222 <param name="window_end" type="integer" value="0" min="0" label="Window end" help="Zero-based"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
223 </when>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
224 </conditional>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
225 <conditional name="log2_transformation_cond">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
226 <param name="log2_transformation" type="select" label="Perform Log2-transformation of the input data">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
227 <option value="no" selected="true">No</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
228 <option value="yes">Yes</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
229 </param>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
230 <when value="no"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
231 <when value="yes">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
232 <param name="log2_num" type="float" value="0" min="0" max="1" label="Enter a number to use log2(x+num) transformation" help="Zero value has no affect"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
233 </when>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
234 </conditional>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
235 <conditional name="max_states_inferred_cond">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
236 <param name="max_states_inferred" type="select" label="Set the maximum number of states to be inferred">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
237 <option value="no" selected="true">No</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
238 <option value="yes">Yes</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
239 </param>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
240 <when value="no"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
241 <when value="yes">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
242 <param name="max_states" type="float" value="1" min="1" label="Maximum number of states to be inferred"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
243 </when>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
244 </conditional>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
245 <conditional name="num_initial_states_cond">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
246 <param name="num_initial_states" type="select" label="Set the initial number of states">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
247 <option value="no" selected="true">No</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
248 <option value="yes">Yes</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
249 </param>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
250 <when value="no"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
251 <when value="yes">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
252 <param name="initial_states" type="integer" value="20" min="1" label="Initial number of states"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
253 </when>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
254 </conditional>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
255 <param name="max_position_classes" type="integer" value="0" min="0" label="Maximum number of position classes to be inferred" help="Zero value has no affect"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
256 <param name="max_cell_type_clusters" type="integer" value="0" min="0" label="Maximum number of cell type clusters allowed" help="Zero value has no affect"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
257 <param name="prior_concentration" type="float" value="0" min="0" label="Prior concentration" help="Zero value results in the default value: sqrt(number of cell types)"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
258 <conditional name="burnin_max_steps_cond">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
259 <param name="burnin_max_steps" type="select" label="Set the the number of burnin and maximization steps">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
260 <option value="no" selected="true">No</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
261 <option value="yes">Yes</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
262 </param>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
263 <when value="no"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
264 <when value="yes">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
265 <param name="burnin_num" type="integer" value="50" min="1" label="Number of burnin steps"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
266 <param name="mcmc_num" type="integer" value="50" min="1" label="Number of maximization steps"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
267 </when>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
268 </conditional>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
269 <conditional name="set_min_standard_dev_cond">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
270 <param name="set_min_standard_dev" type="select" label="Set the minimum standard deviation for the emission Gaussian distribution?">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
271 <option value="no" selected="true">No</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
272 <option value="yes">Yes</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
273 </param>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
274 <when value="no"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
275 <when value="yes">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
276 <param name="min_standard_dev" type="float" value="0.5" label="Minimum standard deviation for the emission Gaussian distribution"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
277 </when>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
278 </conditional>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
279 <conditional name="set_max_standard_dev_cond">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
280 <param name="set_max_standard_dev" type="select" label="Set the maximum standard deviation for the emission Gaussian distribution?">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
281 <option value="no" selected="true">No</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
282 <option value="yes">Yes</option>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
283 </param>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
284 <when value="no"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
285 <when value="yes">
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
286 <param name="max_standard_dev" type="float" value="100000000" label="Maximum standard deviation for the emission Gaussian distribution"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
287 </when>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
288 </conditional>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
289 </inputs>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
290 <outputs>
28
91dc2a532890 Uploaded
greg
parents: 27
diff changeset
291 <data name="output_log" format="txt" label="${tool.name} (ideas output log) on ${on_string}"/>
26
53891e4e4c63 Uploaded
greg
parents: 25
diff changeset
292 <data name="output_cluster" format="txt" label="${tool.name} (local cell type clustering) on ${on_string}"/>
53891e4e4c63 Uploaded
greg
parents: 25
diff changeset
293 <data name="output_para" format="tabular" label="${tool.name} (epigenetic state frequency, mean and variance parameters) on ${on_string}"/>
53891e4e4c63 Uploaded
greg
parents: 25
diff changeset
294 <data name="output_profile" format="txt" label="${tool.name} (profile) on ${on_string}"/>
0
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
295 <data name="output_state" format="txt" label="${tool.name} (epigenetic states and position classes) on ${on_string}"/>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
296 </outputs>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
297 <tests>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
298 </tests>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
299 <help>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
300 **What it does**
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
301
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
302 Employs the IDEAS (Integrative and Discriminative Epigenome Annotation System) method for jointly and quantitatively characterizing
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
303 multivariate epigenetic landscapes in many cell types, tissues or conditions. The method accounts for position dependent epigenetic
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
304 events and detects local cell type relationships, which not only help to improve the accuracy of annotating functional classes of DNA
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
305 sequences, but also reveal cell type constitutive and specific loci. The method utilizes Bayesian non-parametric techniques to automatically
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
306 identify the best model size fitting to the data so users do not have to specify the number of states. On the other hand, users can
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
307 still specify the number of states if desired.
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
308
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
309 -----
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
310
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
311 **Required options**
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
312
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
313 * **Cell type, Epigenetic factor and Input** - specify any number of inputs with currently supported formats, either bam or bigwig. The cell name + factor name must be unique for each input. For example, if you have replicate data you may want to specify the cell name as "cell_rep1", "cell_rep2", etc and the factor name as "factor_rep1", "factor_rep2", etc.
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
314
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
315 * **Cell type name** - cell type name
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
316 * **Epigenetic factor name** - epigenetic factor name
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
317 * **BAM or BigWig file** - BAM or BigWig file
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
318
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
319 * **Set genomic windows on which to process the data** - if "No" is selected, IDEAS will run whole genome segmentation. If "Yes" is selected, IDEAS will segment genomes in the unit of the windows defined by the bed file. This file can be in BED3, BED4 or BED5 format, but only the first three columns (chr posst posed) will be used.
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
320
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
321 * **Window size in base pairs** - Window size in base pairs (if "No" is selected)
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
322 * **Restrict processing to specified chromosomes** - If "Yes" is selected, processing will be restricted to specified chromosomes
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
323
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
324 * **Chromosomes** - processing will be restricted to specified chromosomes (if "Yes" is selected)
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
325
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
326 * **Chromosome** - specified chromosome
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
327
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
328 * **Bed file specifying the genomic windows** - bed file specifying the genomic windows (if "Yes" is selected)
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
329
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
330 **Other options**
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
331
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
332 * **Output chromosomes in seperate files** - select "Yes" to produce seperate files for each chromosome, allowing you to run IDEAS on different chromosomes separately.
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
333 * **Select Bed file containing blacklist regions for exclusion** - select a Bed file that contains regions you'd like excluded from your datasets.
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
334 * **Standardize all datasets** - select "Yes" to standardize all datasets (e.g., reads / total_reads * 20 million) so that the signals from different cell types become comparable - your datasets can be read counts, logp-values or fold change.
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
335
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
336 * **Discourage state transition across chromosomes** - select "Yes" to produce similar states in adjacent windows, making the annotation smoother, but at risk of reducing precision.
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
337 * **Run IDEAS only within defined windows in the input data** - select "Yes" to Run IDEAS only in windows between zero-based start and end indexes of windows in the input data.
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
338 * **Perform Log2-transformation of the input data** - select "Yes" to perform Log2-transformation of the input data by log2(x+1) (recommended for read count data to reduce skewness). You can optionally enter a number less than 1 to direct IDEAS to produce log2(x+num) transformation. For example, if your input data is mean read count per window, then 1 may be too large, but using 0.1 may be more reasonable.
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
339 * **Set the maximum number of states to be inferred** - select "Yes" to restrict the maximum number of states to be generated by IDEAS; the final number of inferred states may be smaller than the number you specified
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
340 * **Set the initial number of states** - select "Yes" if the number of states you expect to generate is greater than 20. While IDEAS may infer 30 states or more by starting from just 20 states, it may not do so if it is trapped in a local mode. We recommend setting the initial number of states slightly larger than the number of states you expect.
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
341 * **Maximum number of position classes to be inferred** - Set this value only if:
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
342
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
343 * you do not want position classes (e.g., for testing purposes), in this case set the value t0 1
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
344 * IDEAS runs slow because there are too many position classes, generally less than 100 position classes will run fine
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
345
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
346 * **Maximum number of cell type clusters allowed** - Set this value only for testing. If you set the value to 1, then all cell types will be clustered in one group.
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
347 * **Prior concentration** - specify the prior concentration parameter; default is A=sqrt(number of cell types). A smaller concentration parameter (e.g., 1 or less) will emphasize more on position specificity and a larger concentration parameter (e.g., 10 * number of cell types) will emphasize more on global homogeneity.
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
348 * **Set the the number of burnin and maximization steps** - specify the number of burnin and maximization steps; default it is 50 50. Increasing these two numbers will increase computing and only slightly increase accuracy. Decreasing these two numbers will reduce computing but may also reduce accuracy. We recommend to run IDEAS with at least 20 burnins and 20 maximizations. IDEAS will not stop even if it reaches a maximum mode.
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
349 * **Set the minimum standard deviation for the emission Gaussian distribution** - specify the minimum standard deviation for the emission Gaussian distribution.
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
350
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
351 * **Minimum standard deviation for the emission Gaussian distribution** - you should change the default minerr value of 0.5 if the standard deviation of your data is much smaller or much larger than 1. The first line of the output produced by IDEAS is **ysd=xxx**, which is the total standard deviation of your data. If that value is less than 0.5, you may set the minimum standard deviation to an even smaller number (e.g., xxx/2). If the standard deviation of your data is much greater than 1, (e.g., 20), you may set the minimum standard deviation to a larger value, (e.g., 5). Modifying the minimum standard deviation in the former case is more necessary than in the latter case because otherwise you may end up finding no interesting segmentations. We do not recommend setting the minimum standard deviation to be 0 or smaller, as doing so may capture some artificial and uninteresting states due to tightly clustered data, such as 0 in read counts.
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
352
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
353 * **Set the maximum standard deviation for the emission Gaussian distribution** - specify the maximim standard deviation for the emission Gaussian distribution.
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
354
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
355 * **Maximim standard deviation for the emission Gaussian distribution** - if you want to find fine-grained states you may use this option (if not used, IDEAS uses infinity), but it is rearely used unless you need more states to be inferred.
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
356
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
357 </help>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
358 <citations>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
359 <citation type="doi">10.1093/nar/gkw278</citation>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
360 </citations>
3b27bfc37b83 Uploaded
greg
parents:
diff changeset
361 </tool>