annotate markersSelection.xml @ 6:7dc6ce39fb89 default tip

add selection tool
author blanck
date Wed, 29 Apr 2015 10:08:52 +0200
parents b7f3854e08f8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
1 <tool id="markersSelection" name="Markers selection" force_history_refresh="True" version="0.1.0">
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
2 <requirement type="package" version="1.1.2">mpagenomics</requirement>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
3 <command interpreter="python">
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
4 markersSelection.py '$input' '$response' '$__new_file_path__' '$folds' '$loss' '$outputlog' '$output' '$log'
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
5 </command>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
6 <inputs>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
7 <param name="input" type="data" format="sef" label="Input Signal" help="see below for more information on file format"/>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
8 <param name="response" type="data" format="csv" label="Data response" help="Data response csv file. See below for more information on file format" />
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
9 <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"/>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
10 <param name="loss" type="select" multiple="false" label="Response type">
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
11 <option value="linear">Linear</option>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
12 <option value="logistic">Logistic</option>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
13 </param>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
14
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
15 <param name="outputgraph" type="select" label="Output figures">
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
16 <option value="TRUE">Yes</option>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
17 <option value="FALSE">No</option>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
18 </param>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
19 <param name="outputlog" type="select" label="Output log">
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
20 <option value="TRUE">Yes</option>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
21 <option value="FALSE">No</option>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
22 </param>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
23 </inputs>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
24 <outputs>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
25 <data format="txt" name="output" label="selection of ${input.name}" />
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
26 <data format="log" name="log" label="log of selection of ${input.name}" >
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
27 <filter>outputlog == "TRUE"</filter>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
28 </data>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
29 </outputs>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
30 <stdio>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
31 <exit_code range="1:" level="fatal" description="See logs for more details" />
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
32 </stdio>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
33 <help>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
34 **What it does**
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
35
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
36 This tool selects some relevant markers according to a response using penalized regressions.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
37
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
38 Input:
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
39
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
40 *A tabular text file containing 3 fixed columns and 1 column per sample:*
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
41
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
42 - chr: Chromosome.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
43 - position: Genomic position (in bp).
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
44 - probeNames: Names of the probes.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
45 - One column per sample which contain the copy number signal for each sample.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
46
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
47 Output:
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
48
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
49 *A tabular text file containing 5 columns which describe all the selected SNPs (1 line per SNP):*
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
50
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
51 - chr: Chromosome containing the selected SNP.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
52 - position: Position of the selected SNP.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
53 - index: Index of the selected SNP.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
54 - names: Name of the selected SNP.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
55 - coefficient: Regression coefficient of the selected SNP.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
56
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
57 -----
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
58
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
59 **Data Response csv file**
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
60
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
61 Data response csv file format:
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
62
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
63 - The first column contains the names of the different files of the dataset.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
64
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
65 - The second column is the response associated with each file.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
66
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
67 - Column names of these two columns are respectively files and response.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
68
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
69 - Columns are separated by a comma
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
70
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
71 - *Extensions of the files (.CEL for example) should be removed*
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
72
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
73
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
74
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
75 **Example**
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
76
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
77 Let 3 .cel files in the studied dataset ::
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
78
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
79 patient1.cel
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
80 patient2.cel
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
81 patient3.cel
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
82
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
83 The csv file should look like this ::
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
84
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
85 files,response
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
86 patient1,1.92145
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
87 patient2,2.12481
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
88 patient3,1.23545
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
89
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
90
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
91 -----
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
92
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
93 **Citation**
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
94
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
95 If you use this tool please cite :
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
96
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
97 `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;`_
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
98
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
99 </help>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
100 </tool>