annotate README.rst @ 5:5de1f2d753fc draft default tip

planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
author iracooke
date Tue, 20 Oct 2015 20:39:36 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
1 Sixframe Translate
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
2 ==================
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
3
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
4 Translate nucleotide sequences to protein
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
5
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
6 Requirements
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
7 ------------
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
8
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
9 This package uses protk_ which needs to be present in order for the tool to work.
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
10
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
11 .. _protk: https://github.com/iracooke/protk
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
12
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
13 There are two ways you can satify this dependency (choose one):
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
14
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
15 1. **Manual Install:** Details on how to install protk_ manually are available here_.
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
16
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
17 2. **Use Docker:** This tool is designed to run inside a docker_ container. If your galaxy supports `running tools within a docker container`__ you don't need to worry about dependencies. Simply install and things should just work. The docker container itself is versioned and new versions of this tool will automatically download an update to the container if needed.
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
18
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
19 .. _docker: https://www.docker.com/
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
20 .. _here: https://github.com/iracooke/protk/#galaxy-integration
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
21 .. _container: https://wiki.galaxyproject.org/Admin/Tools/Docker
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
22 __ container_
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
23
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
24
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
25 Further Info
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
26 ------------
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
27
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
28 The source code for this tool and other protk galaxy tools is on github_. Please visit the github page to contribute to the project or to `report an issue`__
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
29
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
30 .. _github: https://github.com/iracooke/protk-galaxytools
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
31 .. _issue: https://github.com/iracooke/protk-galaxytools/issues
5de1f2d753fc planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/sixframe-translate/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
32 __ issue_