Mercurial > repos > peterjc > venn_list

annotate tools/plotting/venn_list.rst @ 6:6ebfb498c2c4 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
author peterjc
date Wed, 11 Sep 2013 06:46:31 -0400
parents
children 978617e4b6a4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
1 Galaxy tool to draw a Venn Diagram with up to 3 sets
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
2 ====================================================
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
3
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
4 This tool is copyright 2011 by Peter Cock, The James Hutton Institute
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
5 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved.
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
6 See the licence text below.
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
7
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
8 This tool is a short Python script (using both the Galaxy and Biopython library
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
9 functions) to extract ID lists from tabular, FASTA, FASTQ or SFF files to build
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
10 sets, which are then drawn using the R limma package function vennDiagram
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
11 (called from Python using rpy).
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
12
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
13 There are just two files to install:
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
14
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
15 * venn_list.py (the Python script)
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
16 * venn_list.xml (the Galaxy tool definition)
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
17
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
18 The suggested location is in the Galaxy folder tools/plotting next to other
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
19 graph drawing tools.
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
20
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
21 You will also need to install Biopython 1.54 or later, and the R/Bioconductor
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
22 pacakge limma. You should already have rpy installed for other Galaxy tools.
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
23
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
24 You will also need to modify the tools_conf.xml file to tell Galaxy to offer the
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
25 tool. The suggested location is in the "Graph/Display Data" section. Simply add
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
26 the line::
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
27
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
28 <tool file="plotting/venn_list.xml" />
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
29
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
30 If you wish to run the unit tests, also add this to tools_conf.xml.sample and
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
31 move/copy the test-data files under Galaxy's test-data folder. Then::
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
32
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
33 ./run_functional_tests.sh -id venn_list
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
34
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
35
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
36 History
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
37 =======
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
38
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
39 ======= ======================================================================
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
40 Version Changes
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
41 ------- ----------------------------------------------------------------------
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
42 v0.0.3 - Initial public release.
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
43 v0.0.4 - Ignore blank lines when loading IDs from tabular files
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
44 v0.0.5 - Explicit Galaxy error handling of return codes
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
45 v0.0.6 - Added unit tests.
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
46 - Use reStructuredText for this README file.
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
47 - Adopt standard MIT licence.
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
48 - Updated citation information (Cock et al. 2013).
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
49 ======= ======================================================================
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
50
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
51
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
52 Developers
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
53 ==========
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
54
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
55 This script and related tools are being developed on the following hg branch:
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
56 http://bitbucket.org/peterjc/galaxy-central/src/tools
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
57
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
58 For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball use
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
59 the following command from the Galaxy root folder::
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
60
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
61 $ tar -czf venn_list.tar.gz tools/plotting/venn_list.* test-data/venn_list1.pdf test-data/venn_list.tabular test-data/rhodopsin_proteins.fasta
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
62
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
63 Check this worked::
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
64
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
65 $ tar -tzf venn_list.tar.gz
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
66 tools/plotting/venn_list.py
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
67 tools/plotting/venn_list.rst
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
68 tools/plotting/venn_list.xml
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
69 test-data/venn_list1.pdf
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
70 test-data/venn_list.tabular
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
71 test-data/rhodopsin_proteins.fasta
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
72
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
73
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
74 Licence (MIT)
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
75 =============
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
76
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
77 Permission is hereby granted, free of charge, to any person obtaining a copy
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
78 of this software and associated documentation files (the "Software"), to deal
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
79 in the Software without restriction, including without limitation the rights
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
80 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
81 copies of the Software, and to permit persons to whom the Software is
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
82 furnished to do so, subject to the following conditions:
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
83
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
84 The above copyright notice and this permission notice shall be included in
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
85 all copies or substantial portions of the Software.
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
86
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
87 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
88 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
89 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
90 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
91 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
92 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
6ebfb498c2c4 Uploaded v0.0.6 take 3, MIT licence, RST README, citation information
peterjc
parents:
diff changeset
93 THE SOFTWARE.