annotate README.md @ 1:cc6707a1e044 draft default tip

added fixes from Brad Langhorst; https://bitbucket.org/account/notifications/read/3443176/patch-for-proportional-venn-tool-in-galaxy; added tool_dependencies for Mako template untested
author Ido Tamir <ido.tamir@imp.ac.at>
date Mon, 24 Sep 2012 16:46:21 +0200
parents 8ea9b4e5a389
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
1 prop_venn
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
2 ---------
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
3
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
4 crates proportional venn diagrams from 2 or 3 files using google charts.
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
5 pure python implementation
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
6
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
7 contains galaxy tool xml (prop_venn.xml)
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
8
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
9 cli interface expects all arguments for the inputs concatenated
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
10 with , i.e. file1,file2,file3 ...
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
11
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
12 contains an integration test for the cli interface (vennerTest.py), no galaxy unit tests.
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
13
1
cc6707a1e044 added fixes from Brad Langhorst; https://bitbucket.org/account/notifications/read/3443176/patch-for-proportional-venn-tool-in-galaxy; added tool_dependencies for Mako template untested
Ido Tamir <ido.tamir@imp.ac.at>
parents: 0
diff changeset
14 CLI example:
cc6707a1e044 added fixes from Brad Langhorst; https://bitbucket.org/account/notifications/read/3443176/patch-for-proportional-venn-tool-in-galaxy; added tool_dependencies for Mako template untested
Ido Tamir <ido.tamir@imp.ac.at>
parents: 0
diff changeset
15 python venner.py --files testFiles/fileA.tab,testFiles/fileB.tab --columns 1,1 --outname out.html --asNames As,Bs
0
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
16
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
17 Proportional Venn Diagram:
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
18 --------------------------
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
19 Creates a proportional Venn diagram from 2 or 3 tab delimited input files.
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
20 The 0 based column index decides which column is used for extracting the sets to compare between the files.
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
21 Multiple items with the same value per column are counted as one.
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
22
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
23 Requirements:
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
24 -------------
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
25 - 2-3 tab delimited input files.
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
26 - 0 based index of the columns to extract for each file
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
27
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
28 Outputs:
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
29 --------
1
cc6707a1e044 added fixes from Brad Langhorst; https://bitbucket.org/account/notifications/read/3443176/patch-for-proportional-venn-tool-in-galaxy; added tool_dependencies for Mako template untested
Ido Tamir <ido.tamir@imp.ac.at>
parents: 0
diff changeset
30 - Html page with the proportional Venn diagram and a table for the counts in each set.
0
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
31
8ea9b4e5a389 Uploaded
g2cmnty@test-web1.g2.bx.psu.edu
parents:
diff changeset
32