annotate 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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
1 # Created May 2011
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
2 #
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
3 # Alex Bossers
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
4 # Central Veterinary Institute
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
5 # Wageningen University and Research centre
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
6 # Lelystad, The Netherlands
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
7 #
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
8 # Comments/improvements/bugs: Alex (dot) Bossers (at) wur (dot) nl
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
9
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
10
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
11 # WHAT IT DOES
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
12 TopHit_namefilter is a SIMPLE filter to keep just the TOPHIT / first [N] occurrence(s) of some
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
13 identifier. This is useful for keeping only the first N tophits of for instance BLAST when
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
14 multiple hits were returned (and you don't want to rerun the BLAST analysis). Of course it is NOT
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
15 restricted to BLAST and can basically filter ANY tabular data for uniqueness.
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
16
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
17 Please be aware that NO additional filtering or checking is done on for instance E values of BLAST hits.
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
18 Tophit = FIRST hit...not necessarily the best.. If multiple hits are selected to be returned
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
19 they will NOT be sorted (see below example of a number of 2 hits occurring somewhere else in the
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
20 input and therefore in the output file).
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
21
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
22
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
23 # REQUIREMENTS
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
24 Perl
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
25 Galaxy :)
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
26
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
27
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
28 # SETUP
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
29 Just unpack the tool xml and perl script somewhere appropriate and plug the tool in the tool_config.xml
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
30 of your galaxy instance. Refresh the tools or restart the galaxy server.
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
31
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
32
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
33 # LICENSE
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
34 Copyright (c) 2011 Central Veterinary Institute of Wageningen UR, Lelystad, The Netherlands.
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
35
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
36 This program is free software; you can redistribute it and/or modify
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
37 it under the terms of the GNU General Public License as published by
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
38 the Free Software Foundation; either version 3 of the License, or
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
39 (at your option) any later version.
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
40
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
41 When distributing the tools please include this original reference.
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
42
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
43 Use this tool at your own risk. Even though we tried to build tools and wrappers that free of errors,
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
44 check your output since it might be erroneous. We will not be relyable to any failure this may have caused.
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
45
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
46 If you like these scripts, please acknowledge our work.
9f1fe290345e Migrated tool version 0.1.Alx from old tool shed archive to new tool shed repository
abossers
parents:
diff changeset
47