Mercurial > repos > peterjc > venn_list

comparison tools/venn_list/README.rst @ 4:991342eca214 draft

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