annotate profile_cl/profileCLs.xml @ 0:8547aedf1350 draft

Uploaded
author immport-devteam
date Mon, 27 Feb 2017 13:03:19 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
1 <tool id="get_profiles_cell_ontology" name="Associate FLOCK populations" version="1.1">
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
2 <description>with cell ontology</description>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
3 <requirements>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
4 <requirement type="package" version="2.8">jinja2</requirement>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
5 <requirement type="package" version="3.3.0">r</requirement>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
6 <requirement type="package" version="1.11.2">bioconductor-flowcl</requirement>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
7 </requirements>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
8 <stdio>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
9 <exit_code range="2" level="fatal" description="There was a problem running flowCL. You might want to check your marker names - See stderr for more details." />
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
10 <exit_code range="3:" level="fatal" description="See stderr for more details." />
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
11 </stdio>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
12 <command><![CDATA[
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
13 python $__tool_directory__/profileCLs.py -i "${input}" -o "${html_file}" -d "${html_file.files_path}" -t $__tool_directory__
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
14 ]]>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
15 </command>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
16 <inputs>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
17 <param format="flowscore" name="input" type="data" label="Population score profiles from FLOCK"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
18 </inputs>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
19 <outputs>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
20 <data format="html" name="html_file" label="Cell ontology of ${input.name}">
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
21 </data>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
22 </outputs>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
23 <tests>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
24 <test>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
25 <param name="input" value="input.flowscore"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
26 <output name="html_file" file="out.html">
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
27 <extra_files type="file" name="CLprofiles.txt" value="CLprofiles.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
28 <extra_files type="file" name="flowCL_pop01.pdf" value="flowCL_pop01.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
29 <extra_files type="file" name="flowCL_pop01.txt" value="flowCL_pop01.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
30 <extra_files type="file" name="flowCL_pop03.pdf" value="flowCL_pop03.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
31 <extra_files type="file" name="flowCL_pop03.txt" value="flowCL_pop03.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
32 <extra_files type="file" name="flowCL_pop04.pdf" value="flowCL_pop04.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
33 <extra_files type="file" name="flowCL_pop04.txt" value="flowCL_pop04.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
34 <extra_files type="file" name="flowCL_pop05.pdf" value="flowCL_pop05.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
35 <extra_files type="file" name="flowCL_pop05.txt" value="flowCL_pop05.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
36 <extra_files type="file" name="flowCL_pop06.pdf" value="flowCL_pop06.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
37 <extra_files type="file" name="flowCL_pop06.txt" value="flowCL_pop06.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
38 <extra_files type="file" name="flowCL_pop07.pdf" value="flowCL_pop07.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
39 <extra_files type="file" name="flowCL_pop07.txt" value="flowCL_pop07.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
40 <extra_files type="file" name="flowCL_pop09.pdf" value="flowCL_pop09.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
41 <extra_files type="file" name="flowCL_pop09.txt" value="flowCL_pop09.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
42 <extra_files type="file" name="flowCL_pop11.pdf" value="flowCL_pop11.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
43 <extra_files type="file" name="flowCL_pop11.txt" value="flowCL_pop11.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
44 <extra_files type="file" name="flowCL_pop13.pdf" value="flowCL_pop13.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
45 <extra_files type="file" name="flowCL_pop13.txt" value="flowCL_pop13.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
46 <extra_files type="file" name="flowCL_pop14.pdf" value="flowCL_pop14.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
47 <extra_files type="file" name="flowCL_pop14.txt" value="flowCL_pop14.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
48 <extra_files type="file" name="flowCL_pop15.pdf" value="flowCL_pop15.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
49 <extra_files type="file" name="flowCL_pop15.txt" value="flowCL_pop15.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
50 <extra_files type="file" name="flowCL_pop16.pdf" value="flowCL_pop16.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
51 <extra_files type="file" name="flowCL_pop16.txt" value="flowCL_pop16.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
52 <extra_files type="file" name="flowCL_pop17.pdf" value="flowCL_pop17.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
53 <extra_files type="file" name="flowCL_pop17.txt" value="flowCL_pop17.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
54 <extra_files type="file" name="flowCL_pop19.pdf" value="flowCL_pop19.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
55 <extra_files type="file" name="flowCL_pop19.txt" value="flowCL_pop19.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
56 <extra_files type="file" name="flowCL_pop20.pdf" value="flowCL_pop20.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
57 <extra_files type="file" name="flowCL_pop20.txt" value="flowCL_pop20.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
58 <extra_files type="file" name="flowCL_pop22.pdf" value="flowCL_pop22.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
59 <extra_files type="file" name="flowCL_pop22.txt" value="flowCL_pop22.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
60 <extra_files type="file" name="flowCL_pop23.pdf" value="flowCL_pop23.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
61 <extra_files type="file" name="flowCL_pop23.txt" value="flowCL_pop23.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
62 <extra_files type="file" name="flowCL_pop25.pdf" value="flowCL_pop25.pdf" compare="contains"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
63 <extra_files type="file" name="flowCL_pop25.txt" value="flowCL_pop25.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
64 <extra_files type="file" name="scores.txt" value="scores.txt"/>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
65 </output>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
66 </test>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
67 </tests>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
68 <help><![CDATA[
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
69 This tool uses flowCL to find a match for each of the populations defined by FLOCK.
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
70
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
71 .. class:: warningmark
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
72
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
73 here some sort of reminder that trusting data from a software might not be the best way to go necessarily, and that it would be wise oh so wise to still look at the data to make sure that the scores from FLOCK mean what you think they mean.
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
74
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
75 -----
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
76
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
77 **Input**
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
78
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
79 This tool reads in the population score profiles from FLOCK.
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
80
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
81 .. class:: warningmark
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
82
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
83 **The marker names need to be in the cell ontology for this to work**
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
84
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
85 **Output**
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
86
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
87 The output is a page that allows visualization of the data.
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
88
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
89 -----
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
90
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
91 **Example**
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
92
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
93 *Input*
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
94
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
95 *Population profile file*::
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
96
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
97 Population_ID Marker1 Marker2 Marker3 Count Percentage
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
98 1 1 3 2 3885 6.44
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
99 2 1 3 4 2774 4.62
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
100 3 2 2 3 2151 3.59
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
101 4 1 3 2 1207 2.01
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
102
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
103
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
104 *Output*
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
105
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
106 The CL terms hyperlink to their representation in the Immport Cell Ontology browser. The full flowCL run summary is accessible by clicking on the phenotype.
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
107
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
108 .. image:: static/images/profileCL.png
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
109
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
110 .. image:: static/flowtools/popprofiles.png
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
111 ]]>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
112 </help>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
113 <citations>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
114 <citation type="doi">10.1093/bioinformatics/btu807</citation>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
115 </citations>
8547aedf1350 Uploaded
immport-devteam
parents:
diff changeset
116 </tool>