|
1
|
1 Python re-implementation of predictNLS with Galaxy wrapper
|
|
|
2 ==========================================================
|
|
|
3
|
|
|
4 This Galaxy tool is copyright 2011-2013 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 The tool consists of a Galaxy interface definition (predictnls.xml), and a Python
|
|
|
9 script (predictnls.py) which re-implements the command line tool predictNLS. This
|
|
|
10 should match the behaviour of predictNLS v1.0.20 (July 2011), the current latest
|
|
|
11 release from the Rost Lab, see http://rostlab.org and their paper:
|
|
|
12
|
|
|
13 Murat Cokol, Rajesh Nair, and Burkhard Rost.
|
|
|
14 Finding nuclear localization signals.
|
|
|
15 EMBO reports 1(5), 411–415, 2000
|
|
|
16 http://dx.doi.org/10.1093/embo-reports/kvd092
|
|
|
17
|
|
|
18 This wrapper is available from the Galaxy Tool Shed at
|
|
|
19 http://toolshed.g2.bx.psu.edu/view/peterjc/tmhmm_and_signalp
|
|
|
20
|
|
|
21
|
|
|
22 Automatic Installation
|
|
|
23 ======================
|
|
|
24
|
|
|
25 This Galaxy tool is self contained, and so should install automatically via the
|
|
|
26 Galaxy Tool Shed. See http://toolshed.g2.bx.psu.edu/view/peterjc/predictnls
|
|
|
27
|
|
|
28
|
|
|
29 Manual Installation
|
|
|
30 ===================
|
|
|
31
|
|
|
32 There are just four files which should be moved under the Galaxy tools folder,
|
|
|
33 e.g. in a tools/protein_analysis filter:
|
|
|
34
|
|
|
35 * predictlns.xml (the Galaxy tool definition)
|
|
|
36 * predictlns.py (the Python script)
|
|
|
37 * predictlns.txt (this README file)
|
|
|
38 * My_NLS_list (the default set of NLS motifs from the Rost Lab)
|
|
|
39
|
|
|
40 You will also need to modify the tools_conf.xml file to tell Galaxy to offer the
|
|
|
41 tool. If you are using other protein analysis tools like TMHMM or SignalP, put
|
|
|
42 it next to them. Just add the line::
|
|
|
43
|
|
|
44 <tool file="protein_analysis/predictnls.xml" />
|
|
|
45
|
|
|
46 If you want to run the unit tests, also add this to tool_conf.xml.sample, and
|
|
|
47 copy the test files under test-data, then run::
|
|
|
48
|
|
|
49 ./run_functional_tests.sh -id predictnls
|
|
|
50
|
|
|
51 That's it.
|
|
|
52
|
|
|
53
|
|
|
54 History
|
|
|
55 =======
|
|
|
56
|
|
|
57 ======= ======================================================================
|
|
|
58 Version Changes
|
|
|
59 ------- ----------------------------------------------------------------------
|
|
|
60 v0.0.4 - Initial public release.
|
|
|
61 v0.0.5 - Treat non-zero return codes as errors.
|
|
|
62 v0.0.6 - Link to Tool Shed added to help text and this documentation.
|
|
|
63 - Use reStructuredText for this README file.
|
|
|
64 - Updated citation information (Cock et al. 2013).
|
|
|
65 - Development moved to GitHub, https://github.com/peterjc/pico_galaxy
|
|
|
66 ======= ======================================================================
|
|
|
67
|
|
|
68
|
|
|
69 Developers
|
|
|
70 ==========
|
|
|
71
|
|
|
72 This script and related tools are being developed on the following hg branch:
|
|
|
73 http://bitbucket.org/peterjc/galaxy-central/src/tools
|
|
|
74
|
|
|
75 For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball use
|
|
|
76 the following command from the Galaxy root folder::
|
|
|
77
|
|
|
78 $ tar -czf predictnls.tar.gz tools/predictnls/README.rst tools/predictnls/predictnls.xml tools/predictnls/predictnls.py tools/predictnls/My_NLS_list test-data/four_human_proteins.fasta test-data/four_human_proteins.predictnls.tabular
|
|
|
79
|
|
|
80 Check this worked::
|
|
|
81
|
|
|
82 $ tar -tzf predictnls.tar.gz
|
|
|
83 tools/predictnls/README.rst
|
|
|
84 tools/predictnls/predictnls.xml
|
|
|
85 tools/predictnls/predictnls.py
|
|
|
86 tools/predictnls/My_NLS_list
|
|
|
87 test-data/four_human_proteins.fasta
|
|
|
88 test-data/four_human_proteins.predictnls.tabular
|
|
|
89
|
|
|
90
|
|
|
91 Licence (GPL)
|
|
|
92 =============
|
|
|
93
|
|
|
94 This tool is open source, licensed under the GNU GENERAL PUBLIC LICENSE
|
|
|
95 version 3 (GNU v3), see http://www.gnu.org/licenses/gpl.html
|
|
|
96
|
|
|
97 The Python script is my reimplementation of the original Perl program from
|
|
|
98 the Rost Lab, which was released under the GPL v3. Therefore, as I consider
|
|
|
99 this to be a derivative work, this too is released under the GPL v3.
|
|
|
100
|
|
|
101 Please note that the My_NLS_list should be an exact copy of the file of the
|
|
|
102 same name included with predictnls-1.0.7.tar.gz to predictnls-1.0.20.tar.gz
|
|
|
103 inclusive (the list was extended in v1.0.7 in August 2010, see the change log
|
|
|
104 included in those tar-balls), available from ftp://rostlab.org/predictnls/
|
