annotate readme.rst @ 0:57299471d6c1 draft default tip

planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
author yating-l
date Wed, 12 Apr 2017 17:37:47 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
1 Galaxy wrapper for SNAP
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
2 ========================
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
3
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
4 This wrapper is copyright 2016-2017 by Yating Liu
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
5
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
6 This is a wrapper for the gene prediction tool SNAP. SNAP is a general purpose gene finding program suitable for both eukaryotic and prokaryotic genomes. SNAP is an acroynm for Semi-HMM-based Nucleic Acid
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
7 Parser.
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
8
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
9 Reference
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
10 ----------------------
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
11
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
12 Korf I. Gene finding in novel Genomes. BMC Bioinformatics 2004, 5:59
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
13
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
14 Installation
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
15 -----------------------
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
16
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
17 To install SNAP, please download SNAP from
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
18
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
19 http://korflab.ucdavis.edu/Software/snap-2013-11-29.tar.gz
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
20
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
21 and follow the installation instractions. The software is routinely compiled and tested on Mac OS X. It should compile
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
22 fine on any Linux/Unix type operating systems.
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
23 The default compiler is gcc. If you have gcc installed, the easiest is to just compile as:
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
24 ```
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
25 make
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
26 ```
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
27
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
28 The ZOE environment variable is used by SNAP to find the HMM files. Set this
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
29 to the directory containing this file. For example, if you unpackaged the tar-ball in /usr/local/snap, set the ZOE environment variable to /usr/local/snap
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
30
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
31 ```
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
32 setenv ZOE /usr/local/snap # csh, tcsh, etc
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
33 ```
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
34 or
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
35 ```
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
36 export ZOE=/usr/local/snap # sh, bash, etc
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
37 ```
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
38 To install the wrapper copy the snap folder in the galaxy tools and modify the $GALAXY_ROOT/config/tool_conf.xml file to make the tool available to Galaxy. For example:
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
39 ```
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
40 <tool file="galaxy/tools/myTools/snap/snap.xml" />
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
41 ```
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
42
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
43
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
44
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
45
57299471d6c1 planemo upload commit 402a746f69e9f1dbb57007536fc36dc6ce3180de
yating-l
parents:
diff changeset
46