annotate fcs_summary/FCSstats.xml @ 0:1d926a8daa92 draft

Uploaded
author immport-devteam
date Mon, 27 Feb 2017 12:53:11 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
1 <tool id="get_fcs_stats" name="Get summary" version="1.0">
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
2 <description>of FCS files.</description>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
3 <requirements>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
4 <requirement type="package" version="3.3.0">r</requirement>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
5 <requirement type="package" version="1.38.2">bioconductor-flowcore</requirement>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
6 </requirements>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
7 <stdio>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
8 <exit_code range="2:" level="fatal" description="See stderr for more details." />
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
9 </stdio>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
10 <command><![CDATA[
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
11 Rscript --slave --vanilla $__tool_directory__/FCSstats.R --args "${input}" "${output}"
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
12 ]]>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
13 </command>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
14 <inputs>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
15 <param format="fcs" name="input" type="data" label="FCS file"/>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
16 </inputs>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
17 <outputs>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
18 <data format="txt" name="output" label="Summary statisitics of ${input.name}"/>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
19 </outputs>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
20 <tests>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
21 <test>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
22 <param name="input" value="testfcs1.fcs"/>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
23 <output name="output" file="summary.txt"/>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
24 </test>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
25 </tests>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
26 <help><![CDATA[
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
27 This tool generates a summary of a FCS file and list of markers.
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
28
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
29 -----
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
30
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
31 **Input file**
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
32
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
33 This tool uses valid FCS files as input.
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
34
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
35 **Output file**
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
36
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
37 FCS file summary includes number of events, list of markers and parameters, and summary statistics for each.
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
38
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
39 -----
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
40
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
41 **Example**
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
42
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
43 *Output*::
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
44
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
45 events parameters
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
46 20000 6
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
47
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
48
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
49 =========================
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
50 == FCS SUMMARY ==
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
51 =========================
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
52 FSC-H SSC-H FL1-H FL2-H FL3-H FL4-H
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
53 Min. 261 23 0.0 0.0 0.0 0.0
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
54 1st Qu. 371 120 129.0 153.0 257.0 252.0
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
55 Median 432 196 206.0 237.0 432.0 331.0
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
56 Mean 512 476 284.8 236.7 433.2 372.3
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
57 3rd Qu. 657 1023 499.0 297.0 628.0 510.0
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
58 Max. 1023 1023 729.0 925.0 1023.0 1023.0
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
59
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
60
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
61 =========================
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
62 == MARKERS IN FCS ==
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
63 =========================
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
64 channels markers
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
65 1 FSC-H Forward Scatter
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
66 2 SSC-H Side Scatter
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
67 3 FL1-H FITC CD4
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
68 4 FL2-H PE CD25
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
69 5 FL3-H PP CD3
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
70 6 FL4-H APC CD45RA
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
71 ]]>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
72 </help>
1d926a8daa92 Uploaded
immport-devteam
parents:
diff changeset
73 </tool>