diff tools/protein_analysis/README @ 11:99b82a2b1272 draft

Uploaded v0.2.0 which added PSORTb wrapper (written with Konrad Paszkiewicz)
author peterjc
date Wed, 03 Apr 2013 10:49:10 -0400
parents 09ff180d1615
children dc958c2a963a
line wrap: on
line diff
--- a/tools/protein_analysis/README	Wed Mar 27 11:21:05 2013 -0400
+++ b/tools/protein_analysis/README	Wed Apr 03 10:49:10 2013 -0400
@@ -7,13 +7,16 @@
 
 * WoLF PSORT v0.2 from http://wolfpsort.org/
 
+* PSORTb v3 from http://www.psort.org/downloads/index.html
+
 Also, the RXLR motif tool uses SignalP 3.0 and HMMER 2.3.2 internally.
 
 To use these Galaxy wrappers you must first install the command line tools.
-At the time of writing they are all free for academic use.
+At the time of writing they are all free for academic use, or open source.
 
-These wrappers are copyright 2010-2012 by Peter Cock, James Hutton Institute
+These wrappers are copyright 2010-2013 by Peter Cock, James Hutton Institute
 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved.
+Contributions/revisions copyright 2011 Konrad Paszkiewicz. All rights reserved.
 See the included LICENCE file for details (an MIT style open source licence).
 
 Requirements
@@ -60,6 +63,9 @@
 promoter2.xml (Galaxy tool definition)
 promoter2.py (Python wrapper script)
 
+psortb.xml (Galaxy tool definition)
+psortb.py (Python wrapper script)
+
 wolf_psort.xml (Galaxy tool definition)
 wolf_psort.py (Python wrapper script)
 
@@ -77,6 +83,7 @@
   <section name="Protein sequence analysis" id="protein_analysis">
     <tool file="protein_analysis/tmhmm2.xml" />
     <tool file="protein_analysis/signalp3.xml" />
+    <tool file="protein_analysis/psortb.xml" />
     <tool file="protein_analysis/wolf_psort.xml" />
     <tool file="protein_analysis/rxlr_motifs.xml" />
   </section>
@@ -95,17 +102,23 @@
 empty.fasta
 empty_tmhmm2.tabular
 empty_signalp3.tabular
+k12_ten_proteins.fasta
+k12_ten_proteins_psortb_p_terse.tabular
 
 5. Run the Galaxy functional tests for these new wrappers with:
 
 ./run_functional_tests.sh -id tmhmm2
 ./run_functional_tests.sh -id signalp3
+./run_functional_tests.sh -id Psortb
+./run_functional_tests.sh -id rxlr_motifs
 
 Alternatively, this should work (assuming you left the name and id as shown in
 the XML file tool_conf.xml.sample):
 
 ./run_functional_tests.sh -sid Protein_sequence_analysis-protein_analysis
 
+To check the section ID expected, use ./run_functional_tests.sh -list
+
 6. Restart Galaxy and check the new tools are shown and work.
 
 
@@ -130,6 +143,8 @@
 v0.1.2 - Use the new <stdio> settings in the XML wrappers to catch errors
        - Use SGE style $NSLOTS for thread count (otherwise default to 4)
 v0.1.3 - Added missing file whisson_et_al_rxlr_eer_cropped.hmm to Tool Shed
+v0.2.0 - Added PSORTb wrapper to the suite, based on earlier work
+         contributed by Konrad Paszkiewicz.
 
 
 Developers
@@ -144,11 +159,11 @@
 For making the "Galaxy Tool Shed" http://community.g2.bx.psu.edu/ tarball use
 the following command from the Galaxy root folder:
 
-tar -czf ~/tmhmm_signalp_etc.tar.gz tools/protein_analysis/LICENSE tools/protein_analysis/README tools/protein_analysis/suite_config.xml tools/protein_analysis/seq_analysis_utils.py tools/protein_analysis/signalp3.xml tools/protein_analysis/signalp3.py tools/protein_analysis/tmhmm2.xml tools/protein_analysis/tmhmm2.py tools/protein_analysis/promoter2.xml tools/protein_analysis/promoter2.py tools/protein_analysis/wolf_psort.xml tools/protein_analysis/wolf_psort.py tools/protein_analysis/rxlr_motifs.xml tools/protein_analysis/rxlr_motifs.py tools/protein_analysis/whisson_et_al_rxlr_eer_cropped.hmm test-data/four_human_proteins.* test-data/empty.fasta test-data/empty_tmhmm2.tabular test-data/empty_signalp3.tabular
+tar -czf ~/tmhmm_signalp_etc.tar.gz tools/protein_analysis/LICENSE tools/protein_analysis/README tools/protein_analysis/suite_config.xml tools/protein_analysis/seq_analysis_utils.py tools/protein_analysis/signalp3.xml tools/protein_analysis/signalp3.py tools/protein_analysis/tmhmm2.xml tools/protein_analysis/tmhmm2.py tools/protein_analysis/promoter2.xml tools/protein_analysis/promoter2.py tools/protein_analysis/psortb.xml tools/protein_analysis/psortb.py tools/protein_analysis/wolf_psort.xml tools/protein_analysis/wolf_psort.py tools/protein_analysis/rxlr_motifs.xml tools/protein_analysis/rxlr_motifs.py tools/protein_analysis/whisson_et_al_rxlr_eer_cropped.hmm test-data/four_human_proteins.* test-data/empty.fasta test-data/empty_tmhmm2.tabular test-data/empty_signalp3.tabular test-data/k12_ten_proteins.fasta test-data/k12_ten_proteins_psortb_p_terse.tabular
 
 Check this worked:
 
-$ tar -tzf tmhmm_signalp_etc.tar.gz
+$ tar -tzf ~/tmhmm_signalp_etc.tar.gz
 tools/protein_analysis/LICENSE
 tools/protein_analysis/README
 tools/protein_analysis/suite_config.xml
@@ -159,6 +174,8 @@
 tools/protein_analysis/tmhmm2.py
 tools/protein_analysis/promoter2.xml
 tools/protein_analysis/promoter2.py
+tools/protein_analysis/psortb.xml
+tools/protein_analysis/psortb.py
 tools/protein_analysis/wolf_psort.xml
 tools/protein_analysis/wolf_psort.py
 tools/protein_analysis/rxlr_motifs.xml
@@ -170,3 +187,5 @@
 test-data/empty.fasta
 test-data/empty_tmhmm2.tabular
 test-data/empty_signalp3.tabular
+test-data/k12_ten_proteins.fasta
+test-data/k12_ten_proteins_psortb_p_terse.tabular