Mercurial > repos > peterjc > blast_rbh
diff tools/blast_rbh/README.rst @ 1:ff0b814c1320 draft
Uploaded v0.1.5, NCBI BLAST+ 2.2.30 etc
author | peterjc |
---|---|
date | Fri, 21 Nov 2014 06:57:14 -0500 |
parents | b828ca44a313 |
children | 14b2e159b310 |
line wrap: on
line diff
--- a/tools/blast_rbh/README.rst Mon Aug 04 08:13:39 2014 -0400 +++ b/tools/blast_rbh/README.rst Fri Nov 21 06:57:14 2014 -0500 @@ -1,16 +1,19 @@ -Galaxy tool to find BLAST Reciprocal Best Hits (RBH) -==================================================== +Find BLAST Reciprocal Best Hits (RBH), with Galaxy wrapper +========================================================== This tool is copyright 2011-2014 by Peter Cock, The James Hutton Institute (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved. See the licence text below. This tool is a short Python script to run reciprocal BLAST searches on a -pair of sequence files, and extract the reciprocal best hits. +pair of sequence files, and extract the reciprocal best hits. The script +``blast_rbh.py`` can be used directly (without Galaxy) as long as NCBI +BLAST+ is installed. -This is a work in progress, and builds on an earlier implementation which -prequired the two BLAST searches be prepared in advance. Integration allows -a much simpler user experience, and can ensure sensible filters are used. +It comes with an optional Galaxy tool definition file ``blast_rbh.xml`` +allowing the Python script to be run from within Galaxy. It is available +from the Galaxy Tool Shed at: +http://toolshed.g2.bx.psu.edu/view/peterjc/blast_rbh Automated Installation @@ -34,11 +37,10 @@ <tool file="blast_rbh/blast_rbh.xml" /> -If you want to run the functional tests, include the same line in your -``tool_conf.xml.sample`` file, and the sample test files under Galaxy's -``test-data/`` directory. Then:: +If you want to run the functional tests, copy the sample test files under +sample test files under Galaxy's ``test-data/`` directory. Then:: - ./run_functional_tests.sh -id blast_reciprocal_best_hits + ./run_tests.sh -id blast_reciprocal_best_hits You will need to have the NCBI BLAST+ binaries installed and on the ``$PATH``. @@ -52,7 +54,14 @@ v0.1.0 - Initial Test Tool Shed release, targetting NCBI BLAST+ 2.2.29 v0.1.1 - Supports self-comparison, sometimes useful for spotting duplicates. v0.1.2 - Using optparse for command line API. + - Tool definition now embeds citation information. - Fixed Tool Shed dependency definition. +v0.1.3 - Option to make FASTA files non-redundant (via Biopython dependency). + - Avoid extra database and BLAST search in self-comparison mode. +v0.1.4 - Check for duplicate FASTA identifiers (workaround for makeblastdb + not treating this as an error, leading to confusing RBH output). +v0.1.5 - Clarify documentation for using the Python script outside Galaxy. + - Updated to depend on NCBI BLAST+ 2.2.30 via ToolShed install. ======= ======================================================================