annotate readme.rst @ 0:a6098dd0cb46 draft

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