annotate filter.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="callfilter" name="Filter" description="segmented and called data" 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 filter.py '$input' '$length' '$probes' '$__new_file_path__' '$nbcall' '$output' '$outputlog' '$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="scr" label="Segmented and called data file" help="Input file with labelled segments"/>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
8 <param name="length" type="integer" min="1" value="1" label="Minimum length for a segment" help="minimal length (in bp) to keep in a segment"/>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
9 <param name="probes" type="integer" min="1" value="1" label="Minimum probes for a segment" help="minimal number of probes to keep in a segment"/>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
10 <param name="nbcall" type="select" multiple="true" label="Label(s) to keep">
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
11 <option value="double loss">double loss</option>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
12 <option value="loss">loss</option>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
13 <option value="normal">normal</option>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
14 <option value="gain">gain</option>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
15 <option value="amplification">amplification</option>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
16 </param>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
17 <param name="outputlog" type="select" label="Output log">
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
18 <option value="TRUE">Yes</option>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
19 <option value="FALSE">No</option>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
20 </param>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
21 </inputs>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
22
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
23 <outputs>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
24 <data format="txt" name="output" label="filter of ${on_string}" />
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
25
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
26 <data format="log" name="log" label="log of segmentation 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
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
31 <stdio>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
32 <exit_code range="1:" level="fatal" description="See logs for more details" />
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
33 </stdio>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
34 <help>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
35
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
36 **What it does**
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
37
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
38 This tool filters results obtained by the segmentation and calling tool.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
39
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
40 -----
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
41
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
42 Input/Output file:
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
43
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
44 *A tabular text file containing 7 columns:*
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
45
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
46 - sampleNames: Name of the file.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
47 - chrom: Chromosome of the segment.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
48 - chromStart: Starting position (in bp) of the segment. This position is not included in the segment.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
49 - chromEnd: Ending position (in bp) of the segment. This position is included in the segment.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
50 - probes: Number of probes in the segment.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
51 - means: Mean of the segment.
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
52 - calls: Calling of the segment (”double loss”, ”loss”, ”normal”, ”gain” or ”amplification”).
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
53
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
54 -----
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
55
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
56 **Citation**
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
57
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
58 If you use this tool please cite :
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
59
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
60 `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
61
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
62 </help>
b7f3854e08f8 Adding all tools
blanck
parents:
diff changeset
63 </tool>