Mercurial > repos > peterjc > venn_list
annotate tools/venn_list/README.rst @ 5:26e35d5133a1 draft
v0.0.9 - Tool Shed dependency for rpy and limma
author | peterjc |
---|---|
date | Sat, 10 Oct 2015 08:52:01 -0400 |
parents | 991342eca214 |
children | ea68a1a4c1d9 |
rev | line source |
---|---|
4
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
1 Galaxy tool to draw a Venn Diagram with up to 3 sets |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
2 ==================================================== |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
3 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
4 This tool is copyright 2011-2015 by Peter Cock, The James Hutton Institute |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
5 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved. |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
6 See the licence text below. |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
7 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
8 This tool is a short Python script (using both the Galaxy and Biopython library |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
9 functions) to extract ID lists from tabular, FASTA, FASTQ or SFF files to build |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
10 sets, which are then drawn using the R limma package function vennDiagram |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
11 (called from Python using rpy). |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
12 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
13 This tool is available from the Galaxy Tool Shed at: |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
14 http://toolshed.g2.bx.psu.edu/view/peterjc/venn_list |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
15 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
16 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
17 Automated Installation |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
18 ====================== |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
19 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
20 This should be straightforward, Galaxy should automatically download the tool |
5 | 21 and the Python dependencies Biopython and rpy, and the R/Bioconductor package |
22 limma. | |
4
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
23 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
24 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
25 Manual Installation |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
26 =================== |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
27 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
28 There are just two files to install: |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
29 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
30 * ``venn_list.py`` (the Python script) |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
31 * ``venn_list.xml`` (the Galaxy tool definition) |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
32 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
33 The suggested location is in the Galaxy folder ``tools/plotting`` next to other |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
34 graph drawing tools, or a dedicated ``tools/venn_list`` directory. |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
35 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
36 You will also need to install Biopython 1.54 or later, and the R/Bioconductor |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
37 package limma. You should already have rpy installed for other Galaxy tools. |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
38 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
39 You will also need to modify the ``tools_conf.xml`` file to tell Galaxy to offer the |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
40 tool. The suggested location is in the "Graph/Display Data" section. Simply add |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
41 the line:: |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
42 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
43 <tool file="venn_list/venn_list.xml" /> |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
44 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
45 If you wish to run the unit tests, also move/copy the ``test-data/`` files |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
46 under Galaxy's ``test-data/`` folder. Then:: |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
47 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
48 ./run_tests.sh -id venn_list |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
49 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
50 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
51 History |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
52 ======= |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
53 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
54 ======= ====================================================================== |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
55 Version Changes |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
56 ------- ---------------------------------------------------------------------- |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
57 v0.0.3 - Initial public release. |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
58 v0.0.4 - Ignore blank lines when loading IDs from tabular files |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
59 v0.0.5 - Explicit Galaxy error handling of return codes |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
60 v0.0.6 - Added unit tests. |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
61 - Use reStructuredText for this README file. |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
62 - Adopt standard MIT licence. |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
63 - Updated citation information (Cock et al. 2013). |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
64 - Development moved to GitHub, https://github.com/peterjc/pico_galaxy |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
65 v0.0.7 - Renamed folder and README file. |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
66 - Tool definition now embeds citation information. |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
67 v0.0.8 - Reorder XML elements (internal change only). |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
68 - Fixed and improved error handling when rpy is not available. |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
69 - Test output relaxed to cope with more variation in PDF output. |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
70 - Declare Biopython dependency via the Tool Shed. |
5 | 71 v0.0.9 - Test with three-way Venn diagram. |
72 - Includes testing of failure mode. | |
73 - Planemo for Tool Shed upload (``.shed.yml``, internal change only). | |
74 - Tool Shed dependency for rpy and limma (thanks to Björn Grüning). | |
4
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
75 ======= ====================================================================== |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
76 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
77 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
78 Developers |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
79 ========== |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
80 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
81 This script and related tools were initially developed on the following hg branch: |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
82 http://bitbucket.org/peterjc/galaxy-central/src/tools |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
83 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
84 Development has now moved to a dedicated GitHub repository: |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
85 https://github.com/peterjc/pico_galaxy |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
86 |
5 | 87 For pushing a release to the test or main "Galaxy Tool Shed", use the following |
88 Planemo commands (which requires you have set your Tool Shed access details in | |
89 ``~/.planemo.yml`` and that you have access rights on the Tool Shed):: | |
4
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
90 |
5 | 91 $ planemo shed_update -t testtoolshed --check_diff ~/repositories/pico_galaxy/tools/venn_list/ |
92 ... | |
93 | |
94 or:: | |
4
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
95 |
5 | 96 $ planemo shed_update -t toolshed --check_diff ~/repositories/pico_galaxy/tools/venn_list/ |
97 ... | |
98 | |
99 To just build and check the tar ball, use:: | |
4
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
100 |
5 | 101 $ planemo shed_upload --tar_only ~/repositories/pico_galaxy/tools/venn_list/ |
102 ... | |
103 $ tar -tzf shed_upload.tar.gz | |
4
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
104 tools/venn_list/README.rst |
5 | 105 tools/venn_list/tool_dependencies.xml |
4
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
106 tools/venn_list/venn_list.py |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
107 tools/venn_list/venn_list.xml |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
108 test-data/magic.pdf |
5 | 109 test-data/rhodopsin_proteins.fasta |
4
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
110 test-data/venn_list.tabular |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
111 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
112 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
113 Licence (MIT) |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
114 ============= |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
115 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
116 Permission is hereby granted, free of charge, to any person obtaining a copy |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
117 of this software and associated documentation files (the "Software"), to deal |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
118 in the Software without restriction, including without limitation the rights |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
119 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
120 copies of the Software, and to permit persons to whom the Software is |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
121 furnished to do so, subject to the following conditions: |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
122 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
123 The above copyright notice and this permission notice shall be included in |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
124 all copies or substantial portions of the Software. |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
125 |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
126 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
127 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
128 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
129 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
130 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
131 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
991342eca214
Uploaded v0.0.8a, declare Biopython dependency via Tool Shed
peterjc
parents:
diff
changeset
|
132 THE SOFTWARE. |