annotate fingerprint.xml @ 0:0cebe436a553 draft default tip

Initial upload.
author hackdna
date Fri, 17 May 2013 14:29:33 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
1 <tool id="pathprint-fingerprint" name="Create Pathway Fingerprint">
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
2
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
3 <!--
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
4 <description>Create Pathway Fingerprint.</description>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
5 -->
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
6
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
7 <command>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
8 fingerprint.r
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
9 #if $query.type == "geo"
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
10 geo $query.input $output
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
11 #elif $query.type == "cel"
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
12 cel $query.input $output
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
13 #elif $query.type == "expr"
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
14 expr $query.input $query.platform $output
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
15 #end if
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
16 <!--
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
17 > /dev/null 2>&amp;1
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
18 -->
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
19 </command>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
20
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
21 <inputs>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
22 <conditional name="query">
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
23 <param name="type" type="select" label="Query source" help="Select an expression matrix from your User History, or enter a GEO identifier to automatically download an experiment from GEO.">
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
24 <option value="geo">GEO ID</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
25 <!-- <option value="cel">CEL File</option> -->
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
26 <option value="expr" selected="true">Expression Matrix</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
27 </param>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
28
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
29 <when value="geo">
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
30 <param name="input" size="10" type="text" value="GSM99618" label="GEO ID" help="GSM and GSE identifiers are supported. E.g. GSM99618 or GSE4416. Please see below for the list of supported platforms.">
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
31 <validator type="regex" message="The provided GEO ID does not appear to be valid.">^(GSM|GSE|gsm|gse)\d+$</validator>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
32 </param>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
33 </when>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
34
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
35 <!-- shs 042412: no affycel file type available in Upload File -->
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
36 <!-- <when value="cel">
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
37 <param name="input" type="data" label="CEL file" help="Submit an Affymetrix CEL file from your history"/>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
38 </when> -->
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
39
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
40 <when value="expr">
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
41 <param name="input" type="data" label="Expression Matrix" help="The expression matrix is required to have the following format: columns = samples; rows = normalized expression values." />
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
42
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
43 <param name="platform" type="select" label="Platform" help="Select the array platform. Only those in the dropdown list are supported.">
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
44 <option value="GPL72">GPL72 - Affymetrix Drosophila Genome Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
45 <option value="GPL81">GPL81 - Affymetrix Mouse Genome U74A Version 2 Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
46 <option value="GPL85">GPL85 - Affymetrix Rat Genome U34 Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
47 <option value="GPL91">GPL91 - Affymetrix Human Genome U95A Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
48 <option value="GPL96">GPL96 - Affymetrix Human Genome U133A Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
49 <option value="GPL200">GPL200 - Affymetrix C. elegans Genome Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
50 <option value="GPL339">GPL339 - Affymetrix Mouse Expression 430A Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
51 <option value="GPL341">GPL341 - Affymetrix Rat Expression 230A Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
52 <option value="GPL570">GPL570 - Affymetrix Human Genome U133 Plus 2.0 Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
53 <option value="GPL571">GPL571 - Affymetrix Human Genome U133A 2.0 Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
54 <option value="GPL1261">GPL1261 - Affymetrix Mouse Genome 430 2.0 Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
55 <option value="GPL1319">GPL1319 - Affymetrix Zebrafish Genome Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
56 <option value="GPL1322">GPL1322 - Affymetrix Drosophila Genome 2.0 Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
57 <option value="GPL1355">GPL1355 - Affymetrix Rat Genome 230 2.0 Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
58 <option value="GPL2700">GPL2700 - Sentrix HumanRef-8 Expression BeadChip</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
59 <option value="GPL2986">GPL2986 - ABI Human Genome Survey Microarray Version 2</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
60 <option value="GPL2995">GPL2995 - ABI Mouse Genome Survey Microarray</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
61 <option value="GPL3921">GPL3921 - Affymetrix HT Human Genome U133A Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
62 <option value="GPL4685">GPL4685 - Affymetrix GeneChip HT-HG_U133A Early Access Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
63 <option value="GPL6102">GPL6102 - Illumina human-6 v2.0 expression beadchip</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
64 <option value="GPL6103">GPL6103 - Illumina mouseRef-8 v1.1 expression beadchip</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
65 <option value="GPL6104">GPL6104 - Illumina humanRef-8 v2.0 expression beadchip</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
66 <option value="GPL6105">GPL6105 - Illumina mouse-6 v1.1 expression beadchip</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
67 <option value="GPL6244">GPL6244 - Affymetrix Human Gene 1.0 ST Array [transcript (gene) version]</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
68 <option value="GPL6246">GPL6246 - Affymetrix Mouse Gene 1.0 ST Array [transcript (gene) version]</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
69 <option value="GPL6333">GPL6333 - Illumina Mouse Ref-6 V1</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
70 <option value="GPL6883">GPL6883 - Illumina HumanRef-8 v3.0 expression beadchip</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
71 <option value="GPL6884">GPL6884 - Illumina HumanWG-6 v3.0 expression beadchip</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
72 <option value="GPL6885">GPL6885 - Illumina MouseRef-8 v2.0 expression beadchip</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
73 <option value="GPL6887">GPL6887 - Illumina MouseWG-6 v2.0 expression beadchip</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
74 <option value="GPL6947">GPL6947 - Illumina HumanHT-12 v3.0 expression beadchip</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
75 <option value="GPL8300">GPL8300 - Affymetrix Human Genome U95 Version 2 Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
76 <option value="GPL8321">GPL8321 - Affymetrix Mouse Genome 430A 2.0 Array</option>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
77 </param>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
78 </when>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
79 </conditional>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
80 </inputs>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
81
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
82 <outputs>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
83 <data format="tabular" name="output" label="PathPrint fingerprint"/>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
84 </outputs>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
85
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
86 <stdio>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
87 <exit_code range="1:" level="fatal" />
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
88 </stdio>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
89
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
90 <help>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
91
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
92 **What it does**
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
93
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
94 This tool computes a functional pathway profile for the input data. Gene expression values
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
95 for each sample are mapped to a set of 633 pathways that have been curated from KEGG,
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
96 Reactome, WikiPathways and Netpath. Pathways are assigned a value of [-1,0,1], where -1
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
97 indicates low expression, 0 indicates average expression, and +1 indicates high expression
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
98 of the pathway relative to a background comprised of 188,502 arrays from the Gene
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
99 Expression Omnibus (GEO).
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
100
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
101 .. class:: infomark
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
102
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
103 Be sure to select the appropriate platform for your experiment or you may get spurious results. A list of supported platforms is available at the http://compbio.sph.harvard.edu/hidelab/pathprint/Platform_coverage.html.
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
104
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
105 -----
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
106
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
107 **Input**
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
108
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
109 1. Expression Matrix (tabular format): columns represent samples and rows are normalized expression values for each sample. Also specify the appropriate platform (see note above).
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
110
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
111 OR
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
112
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
113 2. GEO series ID (GSE) or sample ID (GSM)
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
114
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
115
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
116 **Output**
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
117
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
118 PathPrint Fingerprint: a tabular format file where columns represent samples and
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
119 row values are pathway activities
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
120
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
121 -----
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
122
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
123 Feedback is welcome. Please send your questions, comments and suggestions to scde@hsci.harvard.edu.
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
124 </help>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
125 </tool>
0cebe436a553 Initial upload.
hackdna
parents:
diff changeset
126