annotate collapse_pop/collapse_pops.xml @ 0:59f859ea3122 draft

Uploaded
author immport-devteam
date Mon, 27 Feb 2017 12:43:35 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
1 <tool id="collapse_populations" name="Collapse populations" version="1.0">
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
2 <description>from FLOCK or Cross Sample analysis.</description>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
3 <requirements>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
4 <requirement type="package" version="0.17.1">pandas</requirement>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
5 </requirements>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
6 <stdio>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
7 <exit_code range="2" level="warning" description="The color code only allows populations between 1 and 40." />
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
8 <exit_code range="3" level="warning" description="The same population to collapse into is being used several times." />
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
9 <exit_code range="4" level="fatal" description="Please provide a comma separated list of populations to collapse." />
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
10 <exit_code range="5" level="warning" description="The color code only allows populations between 1 and 40, and the same population to collapse into is being used several times." />
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
11 <exit_code range="6" level="fatal" description="The populations must be integers (i.e,: 1,2,4.)" />
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
12 <exit_code range="7" level="fatal" description="The same population is being collapsed into 2 different populations." />
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
13 </stdio>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
14 <command><![CDATA[
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
15 python $__tool_directory__/collapse_pops.py -o "${output}" -i "${input}" -p "${population}" -c "${collapse}"
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
16 #for $repeats in $repeat_option
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
17 -p "${repeats.population}"
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
18 -c "${repeats.collapse}"
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
19 #end for
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
20 ]]>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
21 </command>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
22 <inputs>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
23 <param format="flowclr" name="input" type="data" label="Source file"/>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
24 <param name="population" type="text" label="Collapse the following populations:" value="i.e.:2,3,11,25"/>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
25 <param name="collapse" type="text" label="Into population:" value="i.e.:4"/>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
26 <repeat name="repeat_option" title="more populations to manipulate:">
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
27 <param name="population" type="text" label="Collapse the following populations:" value="i.e.:2,3,11,25"/>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
28 <param name="collapse" type="text" label="Into population:" value="i.e.:4"/>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
29 </repeat>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
30 </inputs>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
31 <outputs>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
32 <data format="flowclr" name="output" label="${input.name} with renamed populations"/>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
33 </outputs>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
34 <tests>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
35 <test>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
36 <param name="input" value="input.flowclr"/>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
37 <param name="population" value="2,3,4"/>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
38 <param name="collapse" value="1"/>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
39 <output name="output" file="output.flowclr"/>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
40 </test>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
41 </tests>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
42 <help><![CDATA[
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
43 This tool collapses several populations into one.
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
44
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
45 -----
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
46
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
47 .. class:: warningmark
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
48
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
49 Tip: You can use this tool to assign specific colors to your populations in the FLOCK and Cross Sample overview tools. The color scheme we use is the following:
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
50
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
51 .. image:: static/images/liz_colorcode.png
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
52
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
53 -----
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
54
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
55 **Input**
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
56
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
57 FLOCK or Cross Sample output - a table of the fluorescence intensities for each event and the population associated with each.
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
58
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
59 **Output**
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
60
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
61 The input file with selected populations replaced by the indicated population.
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
62
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
63 -----
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
64
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
65 **Example**
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
66
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
67 *Input* - fluorescence intensities per marker and population ID per event::
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
68
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
69 Marker1 Marker2 Marker3 Population
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
70 34 45 12 1
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
71 33 65 10 5
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
72 19 62 98 2
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
73 12 36 58 1
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
74
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
75 *Populations selected:* 2, 5
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
76
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
77 *Collapse into population:* 3
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
78
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
79 *Output* - fluorescence intensities per marker and population ID per event::
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
80
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
81 Marker1 Marker2 Marker3 Population
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
82 34 45 12 1
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
83 33 65 10 3
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
84 19 62 98 3
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
85 12 36 58 1
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
86
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
87 ]]>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
88 </help>
59f859ea3122 Uploaded
immport-devteam
parents:
diff changeset
89 </tool>