annotate rank_pathways.xml @ 0:580da578c5e6 default tip

Uploaded
author rico
date Thu, 05 Apr 2012 15:56:36 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
580da578c5e6 Uploaded
rico
parents:
diff changeset
1 <tool id="gd_calc_freq" name="Rank" version="1.0.0">
580da578c5e6 Uploaded
rico
parents:
diff changeset
2 <description>affected KEGG pathways</description>
580da578c5e6 Uploaded
rico
parents:
diff changeset
3
580da578c5e6 Uploaded
rico
parents:
diff changeset
4 <command interpreter="python">
580da578c5e6 Uploaded
rico
parents:
diff changeset
5 #if str($output_format) == 'a'
580da578c5e6 Uploaded
rico
parents:
diff changeset
6 calctfreq.py
580da578c5e6 Uploaded
rico
parents:
diff changeset
7 #else if str($output_format) == 'b'
580da578c5e6 Uploaded
rico
parents:
diff changeset
8 calclenchange.py
580da578c5e6 Uploaded
rico
parents:
diff changeset
9 #end if
580da578c5e6 Uploaded
rico
parents:
diff changeset
10 "--loc_file=${GALAXY_DATA_INDEX_DIR}/gd.rank.loc"
580da578c5e6 Uploaded
rico
parents:
diff changeset
11 "--species=${input.metadata.dbkey}"
580da578c5e6 Uploaded
rico
parents:
diff changeset
12 "--input=${input}"
580da578c5e6 Uploaded
rico
parents:
diff changeset
13 "--output=${output}"
580da578c5e6 Uploaded
rico
parents:
diff changeset
14 "--posKEGGclmn=${input.metadata.kegg_path}"
580da578c5e6 Uploaded
rico
parents:
diff changeset
15 "--KEGGgeneposcolmn=${input.metadata.kegg_gene}"
580da578c5e6 Uploaded
rico
parents:
diff changeset
16 </command>
580da578c5e6 Uploaded
rico
parents:
diff changeset
17
580da578c5e6 Uploaded
rico
parents:
diff changeset
18 <inputs>
580da578c5e6 Uploaded
rico
parents:
diff changeset
19 <param name="input" type="data" format="wpf" label="Table">
580da578c5e6 Uploaded
rico
parents:
diff changeset
20 <validator type="metadata" check="kegg_gene,kegg_path" message="Missing KEGG gene code column and/or KEGG pathway code/name column metadata. Click the pencil icon in the history item to edit/save the metadata attributes" />
580da578c5e6 Uploaded
rico
parents:
diff changeset
21 </param>
580da578c5e6 Uploaded
rico
parents:
diff changeset
22 <param name="output_format" type="select" label="Output format">
580da578c5e6 Uploaded
rico
parents:
diff changeset
23 <option value="a" selected="true">ranked by percentage of genes affected</option>
580da578c5e6 Uploaded
rico
parents:
diff changeset
24 <option value="b">ranked by change in length and number of paths</option>
580da578c5e6 Uploaded
rico
parents:
diff changeset
25 </param>
580da578c5e6 Uploaded
rico
parents:
diff changeset
26 </inputs>
580da578c5e6 Uploaded
rico
parents:
diff changeset
27
580da578c5e6 Uploaded
rico
parents:
diff changeset
28 <outputs>
580da578c5e6 Uploaded
rico
parents:
diff changeset
29 <data name="output" format="tabular" />
580da578c5e6 Uploaded
rico
parents:
diff changeset
30 </outputs>
580da578c5e6 Uploaded
rico
parents:
diff changeset
31
580da578c5e6 Uploaded
rico
parents:
diff changeset
32 <tests>
580da578c5e6 Uploaded
rico
parents:
diff changeset
33 <test>
580da578c5e6 Uploaded
rico
parents:
diff changeset
34 <param name="input" value="genome_diversity/test_in/sample.wpf" ftype="wpf" />
580da578c5e6 Uploaded
rico
parents:
diff changeset
35 <param name="output_format" value="a" />
580da578c5e6 Uploaded
rico
parents:
diff changeset
36 <output name="output" file="genome_diversity/test_out/rank_pathways/rank_pathways.tabular" />
580da578c5e6 Uploaded
rico
parents:
diff changeset
37 </test>
580da578c5e6 Uploaded
rico
parents:
diff changeset
38 </tests>
580da578c5e6 Uploaded
rico
parents:
diff changeset
39
580da578c5e6 Uploaded
rico
parents:
diff changeset
40 <help>
580da578c5e6 Uploaded
rico
parents:
diff changeset
41 **What it does**
580da578c5e6 Uploaded
rico
parents:
diff changeset
42
580da578c5e6 Uploaded
rico
parents:
diff changeset
43 This tool produces a table ranking the pathways based on the percentage
580da578c5e6 Uploaded
rico
parents:
diff changeset
44 of genes in an input dataset, out of the total in each pathway.
580da578c5e6 Uploaded
rico
parents:
diff changeset
45 Alternatively, the tool ranks the pathways based on the change in
580da578c5e6 Uploaded
rico
parents:
diff changeset
46 length and number of paths connecting sources and sinks. This change is
580da578c5e6 Uploaded
rico
parents:
diff changeset
47 calculated between graphs representing pathways with and without excluding
580da578c5e6 Uploaded
rico
parents:
diff changeset
48 the nodes that represent the genes in an input list. Sources are all
580da578c5e6 Uploaded
rico
parents:
diff changeset
49 the nodes representing the initial reactants/products in the pathway.
580da578c5e6 Uploaded
rico
parents:
diff changeset
50 Sinks are all the nodes representing the final reactants/products in
580da578c5e6 Uploaded
rico
parents:
diff changeset
51 the pathway.
580da578c5e6 Uploaded
rico
parents:
diff changeset
52
580da578c5e6 Uploaded
rico
parents:
diff changeset
53 If pathways are ranked by percentage of genes affected, the output is
580da578c5e6 Uploaded
rico
parents:
diff changeset
54 a tabular dataset with the following columns:
580da578c5e6 Uploaded
rico
parents:
diff changeset
55
580da578c5e6 Uploaded
rico
parents:
diff changeset
56 1. number of genes in the pathway present in the input dataset
580da578c5e6 Uploaded
rico
parents:
diff changeset
57 2. percentage of the total genes in the pathway included in the input dataset
580da578c5e6 Uploaded
rico
parents:
diff changeset
58 3. rank of the frequency (from high freq to low freq)
580da578c5e6 Uploaded
rico
parents:
diff changeset
59 4. name of the pathway
580da578c5e6 Uploaded
rico
parents:
diff changeset
60
580da578c5e6 Uploaded
rico
parents:
diff changeset
61 If pathways are ranked by change in length and number of paths, the
580da578c5e6 Uploaded
rico
parents:
diff changeset
62 output is a tabular dataset with the following columns:
580da578c5e6 Uploaded
rico
parents:
diff changeset
63
580da578c5e6 Uploaded
rico
parents:
diff changeset
64 1. change in the mean length of paths between sources and sinks
580da578c5e6 Uploaded
rico
parents:
diff changeset
65 2. mean length of paths between sources and sinks in the pathway including the genes in the input dataset. If the pathway do not have sources/sinks, the length is assumed to be infinite (I)
580da578c5e6 Uploaded
rico
parents:
diff changeset
66 3. mean length of paths between sources and sinks in the pathway excluding the genes in the input dataset. If the pathway do not have sources/sinks, the length is assumed to be infinite (I)
580da578c5e6 Uploaded
rico
parents:
diff changeset
67 4. rank of the change in the mean length of paths between sources and sinks (from high change to low change)
580da578c5e6 Uploaded
rico
parents:
diff changeset
68 5. change in the number of paths between sources and sinks
580da578c5e6 Uploaded
rico
parents:
diff changeset
69 6. number of paths between sources and sinks in the pathway including the genes in the input dataset. If the pathway do not have sources/sinks, it is assumed to be a circuit (C)
580da578c5e6 Uploaded
rico
parents:
diff changeset
70 7. number of paths between sources and sinks in the pathway excluding the genes in the input dataset. If the pathway do not have sources/sinks, it is assumed to be a circuit (C)
580da578c5e6 Uploaded
rico
parents:
diff changeset
71 8. rank of the change in the number of paths between sources and sinks (from high change to low change)
580da578c5e6 Uploaded
rico
parents:
diff changeset
72 9. name of the pathway
580da578c5e6 Uploaded
rico
parents:
diff changeset
73 </help>
580da578c5e6 Uploaded
rico
parents:
diff changeset
74 </tool>