annotate readme.rst @ 0:31279c47259a draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
author lecorguille
date Tue, 01 Nov 2016 17:12:07 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
1 Galaxy wrapper for HMMER3
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
2 =========================
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
3
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
4 This wrapper is copyright 2015 by Eric Rasche
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
5
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
6 HMMER is used for searching sequence databases for homologs of protein
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
7 sequences, and for making protein sequence alignments. It implements methods
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
8 using probabilistic models called profile hidden Markov models (profile HMMs).
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
9
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
10 Compared to BLAST, FASTA, and other sequence alignment and database search
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
11 tools based on older scoring methodology, HMMER aims to be significantly more
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
12 accurate and more able to detect remote homologs because of the strength of its
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
13 underlying mathematical models. In the past, this strength came at significant
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
14 computational expense, but in the new HMMER3 project, HMMER is now essentially
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
15 as fast as BLAST.
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
16
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
17 http://hmmer.janelia.org/
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
18 http://hmmer.janelia.org/about
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
19
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
20
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
21 Installation
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
22 ============
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
23
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
24 The recommended installation is by means of the toolshed_.
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
25
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
26 .. _toolshed: http://toolshed.g2.bx.psu.edu/view/iuc/hmmer3
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
27
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
28
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
29 History
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
30 =======
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
31
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
32 * v0.2 - Add build-in hmm database for hmmscan and hmmsearch
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
33 * v0.1 - Initial public release
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
34
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
35
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
36 Licence (MIT)
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
37 =============
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
38
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
39 Permission is hereby granted, free of charge, to any person obtaining a copy
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
40 of this software and associated documentation files (the "Software"), to deal
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
41 in the Software without restriction, including without limitation the rights
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
42 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
43 copies of the Software, and to permit persons to whom the Software is
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
44 furnished to do so, subject to the following conditions:
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
45
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
46 The above copyright notice and this permission notice shall be included in
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
47 all copies or substantial portions of the Software.
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
48
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
49 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
50 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
51 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
52 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
53 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
54 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
31279c47259a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/hmmer3 commit 76281ba139c693f75a900a42c314e74d9649b0ef-dirty
lecorguille
parents:
diff changeset
55 THE SOFTWARE.