diff TopHit_namefilter/TopHit_README @ 0:9f1fe290345e default tip

Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
author abossers
date Tue, 07 Jun 2011 18:07:34 -0400
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/TopHit_namefilter/TopHit_README	Tue Jun 07 18:07:34 2011 -0400
@@ -0,0 +1,47 @@
+# Created May 2011
+#
+# Alex Bossers
+# Central Veterinary Institute
+# Wageningen University and Research centre
+# Lelystad, The Netherlands
+#
+# Comments/improvements/bugs: Alex (dot) Bossers (at) wur (dot) nl
+
+
+# WHAT IT DOES
+TopHit_namefilter is a SIMPLE filter to keep just the TOPHIT / first [N] occurrence(s) of some
+identifier. This is  useful for keeping only the first N tophits of for instance BLAST when
+multiple hits were returned (and you don't want to rerun the BLAST analysis). Of course it is NOT
+restricted to BLAST and can basically filter ANY tabular data for uniqueness.
+
+Please be aware that NO additional filtering or checking is done on for instance E values of BLAST hits.
+Tophit = FIRST hit...not necessarily the best.. If multiple hits are selected to be returned
+they will NOT be sorted (see below example of a number of 2 hits occurring somewhere else in the
+input and therefore in the output file).
+
+
+# REQUIREMENTS 
+Perl
+Galaxy :)
+
+
+# SETUP 
+Just unpack the tool xml and perl script somewhere appropriate and plug the tool in the tool_config.xml
+of your galaxy instance. Refresh the tools or restart the galaxy server.
+
+
+# LICENSE
+Copyright (c) 2011 Central Veterinary Institute of Wageningen UR, Lelystad, The Netherlands.
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
+
+When distributing the tools please include this original reference.
+
+Use this tool at your own risk. Even though we tried to build tools and wrappers that free of errors,
+check your output since it might be erroneous. We will not be relyable to any failure this may have caused.
+
+If you like these scripts, please acknowledge our work.
+