annotate rgweblogo/README @ 9:3af85bc54c8d draft

Uploaded
author fubar
date Wed, 11 Dec 2013 00:26:52 -0500
parents fad187cb76fe
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
fad187cb76fe Uploaded
fubar
parents:
diff changeset
1 This is a Galaxy tool wrapper for weblogo3 already available as a web app at the site below but neat as a Galaxy tool
fad187cb76fe Uploaded
fubar
parents:
diff changeset
2 Last updated by Ross to install iuc ghostscript and numpy dependencies.
fad187cb76fe Uploaded
fubar
parents:
diff changeset
3
fad187cb76fe Uploaded
fubar
parents:
diff changeset
4 Weblogo generates sequence logos from fasta files such as the alignments generated by clustalw
fad187cb76fe Uploaded
fubar
parents:
diff changeset
5
fad187cb76fe Uploaded
fubar
parents:
diff changeset
6 Note that the image for the help must be in static/images for it to show up on the tool form - it's the same image as goes in test-data
fad187cb76fe Uploaded
fubar
parents:
diff changeset
7
fad187cb76fe Uploaded
fubar
parents:
diff changeset
8 **Automated Installation**
fad187cb76fe Uploaded
fubar
parents:
diff changeset
9 As a Galaxy admin, use the admin menu and select the search ToolShed option. This tool should be on the main toolshed - if not try the test toolshed.
fad187cb76fe Uploaded
fubar
parents:
diff changeset
10 Select it and choose "preview and install" - the process of downloading and installing weblogo3.3 and this wrapper should take a few minutes at most.
fad187cb76fe Uploaded
fubar
parents:
diff changeset
11
fad187cb76fe Uploaded
fubar
parents:
diff changeset
12 ** Manual Installation**
fad187cb76fe Uploaded
fubar
parents:
diff changeset
13
fad187cb76fe Uploaded
fubar
parents:
diff changeset
14 Don't.
fad187cb76fe Uploaded
fubar
parents:
diff changeset
15
fad187cb76fe Uploaded
fubar
parents:
diff changeset
16 If you insist,
fad187cb76fe Uploaded
fubar
parents:
diff changeset
17 Make sure weblogo3 is installed in your system python and is available on the path for all your nodes
fad187cb76fe Uploaded
fubar
parents:
diff changeset
18
fad187cb76fe Uploaded
fubar
parents:
diff changeset
19 Move the test data files to your galaxy root test-data
fad187cb76fe Uploaded
fubar
parents:
diff changeset
20 Move the xml file to a subdirectory of your tools folder (eg rgenetics/) and then add a line in your tool_conf.xml to point there.
fad187cb76fe Uploaded
fubar
parents:
diff changeset
21 Run
fad187cb76fe Uploaded
fubar
parents:
diff changeset
22 sh run_functional_tests.sh -id weblogo3
fad187cb76fe Uploaded
fubar
parents:
diff changeset
23 to make sure the tests work
fad187cb76fe Uploaded
fubar
parents:
diff changeset
24
fad187cb76fe Uploaded
fubar
parents:
diff changeset
25 then restart Galaxy and you should be good to go.
fad187cb76fe Uploaded
fubar
parents:
diff changeset
26
fad187cb76fe Uploaded
fubar
parents:
diff changeset
27
fad187cb76fe Uploaded
fubar
parents:
diff changeset
28 **Attribution**
fad187cb76fe Uploaded
fubar
parents:
diff changeset
29
fad187cb76fe Uploaded
fubar
parents:
diff changeset
30 Source for the weblogo3 python executable is at http://weblogo.berkeley.edu
fad187cb76fe Uploaded
fubar
parents:
diff changeset
31
fad187cb76fe Uploaded
fubar
parents:
diff changeset
32 Galaxy tool wrapper written by Ross Lazarus for the Rgenetics project
fad187cb76fe Uploaded
fubar
parents:
diff changeset
33
fad187cb76fe Uploaded
fubar
parents:
diff changeset
34 Copyright Ross Lazarus at gmail com 2011
fad187cb76fe Uploaded
fubar
parents:
diff changeset
35
fad187cb76fe Uploaded
fubar
parents:
diff changeset
36 All rights reserved.
fad187cb76fe Uploaded
fubar
parents:
diff changeset
37
fad187cb76fe Uploaded
fubar
parents:
diff changeset
38 Released under the LGPL - see http://www.gnu.org/copyleft/lesser.html