annotate pathway_image.xml @ 32:03c22b722882

remove BeautifulSoup dependency
author Richard Burhans <burhans@bx.psu.edu>
date Fri, 20 Sep 2013 13:54:23 -0400
parents a631c2f6d913
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
23
66a183c44dd5 bugfix for Pathway Image tool
Richard Burhans <burhans@bx.psu.edu>
parents: 21
diff changeset
1 <tool id="gd_pathway_image" name="Pathway Image" version="1.1.0">
14
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
2 <description>: Draw a KEGG pathway, highlighting specified gene modules</description>
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
3
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
4 <command interpreter="python">
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
5 mkpthwpng.py
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
6 "--input=${input}"
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
7 "--output=${output}"
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
8 "--KEGGpath=${pathway}"
21
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
9 "--posKEGGclmn=${kpath}"
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
10 "--KEGGgeneposcolmn=${kgene}"
14
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
11 </command>
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
12
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
13 <inputs>
21
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
14 <param name="input" type="data" format="tabular" label="Dataset" />
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
15 <param name="kgene" type="data_column" data_ref="input" label="Column with KEGG gene ID" />
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
16 <param name="kpath" type="data_column" data_ref="input" numerical="false" label="Column with KEGG pathways" />
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
17 <param name="pathway" label="Pathway" type="select">
14
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
18 <options from_file="gd.pathways.txt">
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
19 <column name="value" index="1"/>
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
20 <column name="name" index="2"/>
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
21 <filter type="data_meta" ref="input" key="dbkey" column="0" separator="\t" />
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
22 </options>
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
23 </param>
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
24 </inputs>
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
25
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
26 <outputs>
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
27 <data name="output" format="png" />
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
28 </outputs>
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
29
31
a631c2f6d913 Update to Miller Lab devshed revision 3c4110ffacc3
Richard Burhans <burhans@bx.psu.edu>
parents: 23
diff changeset
30 <requirements>
a631c2f6d913 Update to Miller Lab devshed revision 3c4110ffacc3
Richard Burhans <burhans@bx.psu.edu>
parents: 23
diff changeset
31 <requirement type="package" version="0.2.5">mechanize</requirement>
a631c2f6d913 Update to Miller Lab devshed revision 3c4110ffacc3
Richard Burhans <burhans@bx.psu.edu>
parents: 23
diff changeset
32 </requirements>
a631c2f6d913 Update to Miller Lab devshed revision 3c4110ffacc3
Richard Burhans <burhans@bx.psu.edu>
parents: 23
diff changeset
33
14
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
34 <tests>
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
35 <test>
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
36 <param name="input" value="test_in/sample.gd_sap" ftype="gd_sap" />
21
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
37 <param name="kpath" value="10" />
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
38 <param name="kgene" value="12" />
14
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
39 <param name="pathway" value="cfa05214" />
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
40 <output name="output" file="test_out/pathway_image/pathway_image.png" compare="sim_size" delta = "10000" />
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
41 </test>
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
42 </tests>
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
43
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
44 <help>
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
45
21
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
46 **Dataset formats**
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
47
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
48 The input and output datasets are in tabular_ format.
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
49 The input dataset must have columns with KEGG gene ID and pathways.
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
50 The output dataset is described below.
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
51 (`Dataset missing?`_)
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
52
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
53 .. _tabular: ./static/formatHelp.html#tab
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
54 .. _Dataset missing?: ./static/formatHelp.html
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
55
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
56 -----
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
57
14
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
58 **What it does**
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
59
21
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
60 This tool produces an image of a KEGG pathway, highlighting (in red) the
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
61 modules representing genes in the input dataset. Click here_ for help
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
62 with reading the pathway map.
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
63
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
64 NOTE: a given gene can
14
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
65 be assigned to multiple modules, and different genes can be assigned to
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
66 the same module.
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
67
21
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
68 .. _here: http://www.genome.jp/kegg/document/help_pathway.html
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
69
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
70 -----
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
71
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
72 **Example**
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
73
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
74 - input::
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
75
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
76 476153 probably damaging cfa00230=Purine metabolism.cfa00500=Starch and sucrose metabolism.cfa00740=Riboflavin metabolism.cfa00760=Nicotinate and nicotinamide metabolism.cfa00770=Pantothenate and CoA biosynthesis.cfa01100=Metabolic pathways
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
77 483960 probably damaging N
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
78 610160 possibly damaging N
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
79 403657 benign cfa04010=MAPK signaling pathway.cfa04012=ErbB signaling pathway.cfa04060=Cytokine-cytokine receptor interaction.cfa04144=Endocytosis.cfa04510=Focal adhesion.cfa04540=Gap junction.cfa04810=Regulation of actin cytoskeleton.cfa05160=Hepatitis C.cfa05200=Pathways in cancer.cfa05212=Pancreatic cancer.cfa05213=Endometrial cancer.cfa05214=Glioma.cfa05215=Prostate cancer.cfa05218=Melanoma.cfa05219=Bladder cancer.cfa05223=Non-small cell lung cancer
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
80 etc.
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
81
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
82 output showing pathway cfa05214:
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
83
31
a631c2f6d913 Update to Miller Lab devshed revision 3c4110ffacc3
Richard Burhans <burhans@bx.psu.edu>
parents: 23
diff changeset
84 .. image:: $PATH_TO_IMAGES/gd_pathway_image.png
21
d6b961721037 Miller Lab Devshed version 4c04e35b18f6
Richard Burhans <burhans@bx.psu.edu>
parents: 14
diff changeset
85
14
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
86 </help>
8ae67e9fb6ff Uploaded Miller Lab Devshed version a51c894f5bed again [possible toolshed.g2 bug]
miller-lab
parents:
diff changeset
87 </tool>