annotate selection.xml @ 6:7dc6ce39fb89 default tip

add selection tool
author blanck
date Wed, 29 Apr 2015 10:08:52 +0200
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
1 <tool id="selection" name="Markers selection" force_history_refresh="True" version="0.1.0">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
2 <command interpreter="python">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
3 selection.py '$input' '$response' '$chromosome' '$__new_file_path__' '$settingsSNP.signal'
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
4 #if $settingsSNP.signal == "CN":
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
5 '$settingsSNP.snp'
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
6 #end if
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
7 #if $settingsSNP.signal == "fracB":
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
8 'none'
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
9 #end if
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
10 '$settings.settingsType'
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
11 #if $settings.settingsType == "tumor":
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
12 '$tumorcsv'
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
13 #end if
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
14 #if $settings.settingsType == "standard":
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
15 'none'
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
16 #end if
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
17 '$folds' '$settingsLoss.loss' '$outputgraph' '$output' '$pdffigures' '$outputlog' '$log' '$__user_id__'
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
18 #if $settingsLoss.loss == "linear":
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
19 '$settingsLoss.package'
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
20 #end if
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
21 #if $settingsLoss.loss == "logistic":
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
22 'HDPenReg'
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
23 #end if
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
24 </command>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
25 <inputs>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
26 <param name="input" type="data" format="dsf" label="Dataset summary file" help="Summary text file generated by the Data normalization tool"/>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
27
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
28 <param name="response" type="data" format="csv" label="Data response" help="Data response csv file. See below for more information on file format" />
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
29
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
30 <param name="chromosome" type="select" size="6" multiple="true" label="Chromosomes">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
31 <option value="1">chr 1</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
32 <option value="2">chr 2</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
33 <option value="3">chr 3</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
34 <option value="4">chr 4</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
35 <option value="5">chr 5</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
36 <option value="6">chr 6</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
37 <option value="7">chr 7</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
38 <option value="8">chr 8</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
39 <option value="9">chr 9</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
40 <option value="10">chr 10</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
41 <option value="11">chr 11</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
42 <option value="12">chr 12</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
43 <option value="13">chr 13</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
44 <option value="14">chr 14</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
45 <option value="15">chr 15</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
46 <option value="16">chr 16</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
47 <option value="17">chr 17</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
48 <option value="18">chr 18</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
49 <option value="19">chr 19</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
50 <option value="20">chr 20</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
51 <option value="21">chr 21</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
52 <option value="22">chr 22</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
53 <option value="23">chr 23</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
54 <option value="24">chr 24</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
55 <option value="25">chr 25</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
56 </param>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
57 <conditional name="settingsSNP">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
58 <param name="signal" type="select" multiple="false" label="Signal you want to work on">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
59 <option value="CN">CN</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
60 <option value="fracB">fracB</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
61 </param>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
62 <when value="fracB"/>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
63 <when value="CN">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
64 <param name="snp" type="select" label="Select Probes">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
65 <option value="FALSE">CN and SNP probes</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
66 <option value="TRUE">Only SNP probes</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
67 </param>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
68 </when>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
69 </conditional>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
70 <conditional name="settings">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
71 <param name="settingsType" type="select" label="Reference" help="">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
72 <option value="standard">Study without reference</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
73 <option value="tumor">Normal-tumor study</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
74 </param>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
75 <when value="standard" />
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
76 <when value="tumor">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
77 <param name="tumorcsv" type="data" format="csv" label="tumor boost csv file" help="Normal-tumor csv file. See below for more information."/>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
78 </when>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
79 </conditional>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
80
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
81 <param name="folds" type="integer" min="1" value="10" label ="Number of folds for cross validation" help="Integer between 1 and number of file in the .cel file dataset"/>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
82 <conditional name="settingsLoss">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
83 <param name="loss" type="select" multiple="false" label="Response type">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
84 <option value="linear">Linear</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
85 <option value="logistic">Logistic</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
86 </param>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
87 <when value="logistic" />
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
88 <when value="linear">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
89 <param name="package" type="select" multiple="false" label="Method" help="Either “HDPenReg” or “spikeslab”. Used package in linear case">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
90 <option value="HDPenReg">HDPenReg</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
91 <option value="spikeslab">spikeslab</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
92 </param>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
93 </when>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
94 </conditional>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
95 <param name="outputgraph" type="select" multiple="false" label="Plot figures">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
96 <option value="TRUE">Yes</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
97 <option value="FALSE">No</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
98 </param>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
99 <param name="outputlog" type="select" label="Output log">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
100 <option value="TRUE">Yes</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
101 <option value="FALSE">No</option>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
102 </param>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
103
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
104 </inputs>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
105 <outputs>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
106 <data format="txt" name="output" label="selection of ${input.name}" />
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
107 <data format="pdf" name="pdffigures" label="figures of SNPs selection of ${input.name}">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
108 <filter>outputgraph == "TRUE"</filter>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
109 <filter>(settingsLoss['package'] != 'spikeslab')</filter>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
110 </data>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
111 <data format="log" name="log" label="log of SNPs selection of ${input.name}">
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
112 <filter>outputlog == "TRUE"</filter>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
113 </data>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
114 </outputs>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
115 <stdio>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
116 <exit_code range="1:" level="fatal" description="See logs for more details" />
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
117 </stdio>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
118 <help>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
119 .. class:: warningmark
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
120
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
121 Data normalization must be run with the Data Normalization tool prior to SNPs selection. Otherwise, the standalone version can be used to perform marker selection from matrices containing data normalized with tools different from the one proposed in this instance.
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
122
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
123 -----
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
124
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
125 **What it does**
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
126
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
127 This tool selects some relevant markers according to a response using penalized regressions.
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
128
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
129 Output:
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
130
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
131 A tabular text file containing 5 columns which describe all the selected SNPs (1 line per SNPs):
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
132
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
133 - chr: Chromosome containing the selected SNP.
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
134 - position: Position of the selected SNP.
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
135 - index: Index of the selected SNP.
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
136 - names: Name of the selected SNP.
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
137 - coefficient: Regression coefficient of the selected SNP.
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
138
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
139 -----
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
140
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
141 **Data Response csv file**
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
142
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
143 Data response csv file format:
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
144
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
145 - The first column contains the names of the different files of the data-set.
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
146
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
147 - The second column contains the response associated with each file.
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
148
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
149 - Column names of these two columns are respectively files and response.
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
150
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
151 - Columns are separated by a comma
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
152
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
153 - *Extensions of the files (.CEL for example) should be removed*
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
154
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
155
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
156
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
157 **Example**
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
158
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
159 Let 3 .cel files in the studied dataset ::
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
160
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
161 patient1.cel
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
162 patient2.cel
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
163 patient3.cel
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
164
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
165 The csv file should look like this ::
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
166
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
167 files,response
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
168 patient1,1.92145
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
169 patient2,2.12481
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
170 patient3,1.23545
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
171
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
172
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
173 -----
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
174
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
175 **Normal-tumor study**
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
176
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
177 In cases where normal (control) samples match to tumor samples, they are taken as references to extract copy number profile. In this case, a normal-tumor csv file must be provided :
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
178
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
179 - The first column contains the names of the files corresponding to normal samples of the dataset.
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
180
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
181 - The second column contains the names of the tumor samples files.
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
182
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
183 - Column names of these two columns are respectively normal and tumor.
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
184
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
185 - Columns are separated by a comma.
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
186
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
187 - *Extensions of the files (.CEL for example) should be removed*
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
188
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
189
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
190 **Example**
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
191
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
192 Let 6 .cel files in the studied dataset (3 patients, each of them being represented by a couple of normal and tumor cel file.) ::
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
193
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
194 patient1_normal.cel
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
195 patient1_tumor.cel
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
196 patient2_normal.cel
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
197 patient2_tumor.cel
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
198 patient3_normal.cel
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
199 patient3_tumor.cel
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
200
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
201
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
202 The csv file should look like this ::
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
203
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
204 normal,tumor
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
205 patient1_normal,patient1_tumor
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
206 patient2_normal,patient2_tumor
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
207 patient3_normal,patient3_tumor
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
208
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
209 -----
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
210
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
211
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
212
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
213 **Citation**
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
214
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
215 If you use this tool please cite :
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
216
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
217 `Q. Grimonprez, A. Celisse, M. Cheok, M. Figeac, and G. Marot. MPAgenomics : An R package for multi-patients analysis of genomic markers, 2014. Preprint &lt;http://fr.arxiv.org/abs/1401.5035&gt;`_
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
218
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
219 </help>
7dc6ce39fb89 add selection tool
blanck
parents:
diff changeset
220 </tool>