annotate auto_collapse_pop/auto_collapse_pops.xml @ 0:7632562ada41 draft

Uploaded
author immport-devteam
date Mon, 27 Feb 2017 12:14:29 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
1 <tool id="auto_collapse_populations" name="Collapse populations automatically" version="1.0">
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
2 <description>based on quartile binning from FLOCK results.</description>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
3 <requirements>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
4 <requirement type="package" version="0.17.1">pandas</requirement>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
5 </requirements>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
6 <stdio>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
7 <exit_code range="1:" />
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
8 </stdio>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
9 <command><![CDATA[
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
10 python $__tool_directory__/auto_collapse_pops.py -o "${output}" -i "${input}" -p "${profile}" -r "${report}"
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
11 ]]>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
12 </command>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
13 <inputs>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
14 <param format="flowclr" name="input" type="data" label="FLOCK or Cross-Sample output file"/>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
15 <param format="flowscore" name="profile" type="data" label="Population score profiles from FLOCK"/>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
16 </inputs>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
17 <outputs>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
18 <data format="flowclr" name="output" label="Auto-collapsed pops in ${input.name}"/>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
19 <data format="tabular" name="report" label="Auto-collapse report for ${input.name} with ${profile.name}"/>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
20 </outputs>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
21 <tests>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
22 <test>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
23 <param name="input" value="input.flowclr"/>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
24 <param name="profile=" value="profile.flowscore"/>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
25 <param name="report" value="report.txt"/>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
26 <output name="output" file="output.flowclr"/>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
27 </test>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
28 </tests>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
29 <help><![CDATA[
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
30 This tool automatically collapses populations together based on FLOCK score profiles.
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
31
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
32 -----
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
33
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
34 .. class:: warningmark
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
35
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
36 *FLOCK score profiles are assigned based on quartile binning of the data. As always, use this tool with caution and be critical of your results*
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
37
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
38 -----
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
39
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
40 **Input**
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
41
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
42 FLOCK or Cross Sample output - a table of the fluorescence intensities for each event and the population associated with each, as well as the file containing the score profiles for each FLOCK population.
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
43
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
44 **Output**
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
45
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
46 The input file with selected populations replaced by the indicated population. This tool also generates a report.
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
47
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
48 -----
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
49
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
50 **Example**
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
51
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
52 *Input* - fluorescence intensities per marker and population ID per event::
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
53
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
54 Marker1 Marker2 Marker3 Population
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
55 34 45 12 1
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
56 33 65 10 5
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
57 19 62 98 2
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
58 12 36 58 3
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
59
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
60 *Population profile file*::
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
61
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
62 Population_ID Marker1 Marker2 Marker3 Count Percentage
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
63 1 2 2 3 3885 6.44
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
64 2 1 3 4 2774 4.62
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
65 3 2 2 3 2151 3.59
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
66 4 1 3 2 1207 2.01
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
67
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
68 *Output* - fluorescence intensities per marker and population ID per event::
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
69
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
70 Marker1 Marker2 Marker3 Population
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
71 34 45 12 1
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
72 33 65 10 4
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
73 19 62 98 2
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
74 12 36 58 1
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
75
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
76 *Output* - fluorescence intensities per marker and population ID per event::
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
77
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
78 New_Population Former_Populations Marker1 Marker2 Marker3
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
79 1 1, 3 2 2 3
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
80 2 2 1 3 4
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
81 3 4 1 3 2
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
82 4 5, 8, 12 3 1 1
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
83 ]]>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
84 </help>
7632562ada41 Uploaded
immport-devteam
parents:
diff changeset
85 </tool>