annotate venn_list-c96bef0643dc/tools/plotting/venn_list.txt @ 1:116ccf1c84d5 draft

Uploaded v0.0.5
author peterjc
date Thu, 16 May 2013 12:37:09 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
1 Galaxy tool to draw a Venn Diagram with up to 3 sets
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
2 ====================================================
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
3
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
4 This tool is copyright 2011 by Peter Cock, The James Hutton Institute
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
5 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved.
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
6 See the licence text below.
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
7
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
8 This tool is a short Python script (using both the Galaxy and Biopython library
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
9 functions) to extract ID lists from tabular, FASTA, FASTQ or SFF files to build
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
10 sets, which are then drawn using the R limma package function vennDiagram
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
11 (called from Python using rpy).
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
12
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
13 There are just two files to install:
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
14
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
15 * venn_list.py (the Python script)
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
16 * venn_list.xml (the Galaxy tool definition)
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
17
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
18 The suggested location is in the Galaxy folder tools/plotting next to other
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
19 graph drawing tools.
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
20
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
21 You will also need to modify the tools_conf.xml file to tell Galaxy to offer the
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
22 tool. The suggested location is in the "Graph/Display Data" section. Simply add
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
23 the line:
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
24
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
25 <tool file="plotting/venn_list.xml" />
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
26
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
27 You will also need to install Biopython 1.54 or later, and the R/Bioconductor
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
28 pacakge limma. You should already have rpy installed for other Galaxy tools.
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
29
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
30
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
31 History
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
32 =======
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
33
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
34 v0.0.3 - Initial public release.
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
35
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
36
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
37 Developers
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
38 ==========
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
39
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
40 This script and related tools are being developed on the following hg branch:
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
41 http://bitbucket.org/peterjc/galaxy-central/src/tools
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
42
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
43 For making the "Galaxy Tool Shed" http://community.g2.bx.psu.edu/ tarball use
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
44 the following command from the Galaxy root folder:
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
45
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
46 tar -czf venn_list.tar.gz tools/plotting/venn_list.*
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
47
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
48 Check this worked:
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
49
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
50 $ tar -tzf venn_list.tar.gz
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
51 tools/plotting/venn_list.py
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
52 tools/plotting/venn_list.txt
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
53 tools/plotting/venn_list.xml
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
54
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
55
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
56 Licence (MIT/BSD style)
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
57 =======================
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
58
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
59 Permission to use, copy, modify, and distribute this software and its
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
60 documentation with or without modifications and for any purpose and
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
61 without fee is hereby granted, provided that any copyright notices
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
62 appear in all copies and that both those copyright notices and this
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
63 permission notice appear in supporting documentation, and that the
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
64 names of the contributors or copyright holders not be used in
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
65 advertising or publicity pertaining to distribution of the software
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
66 without specific prior permission.
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
67
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
68 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
69 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
70 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
71 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
72 OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
73 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
74 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
116ccf1c84d5 Uploaded v0.0.5
peterjc
parents:
diff changeset
75 OR PERFORMANCE OF THIS SOFTWARE.