annotate README.rst @ 1:a85c8de9630a draft

Add tool-data
author iracooke
date Thu, 26 Mar 2015 20:16:00 -0400
parents 28067ed4ea0e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
1 Protk Proteogenomics
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
2 ====================
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
3
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
4 Map peptides and proteins to genomic (or transcriptomic) coordinates
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
5
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
6 Requirements
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
7 ------------
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
8
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
9 This package uses protk_ and blast_ which need to be present in order for the tools to work.
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
10
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
11 .. _protk: https://github.com/iracooke/protk
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
12 .. _blast: https://toolshed.g2.bx.psu.edu/view/devteam/ncbi_blast_plus
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
13
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
14 When installing this package, if you instruct galaxy to install dependencies it will automatically install blast_ but installation of protk_ may require additional steps (see below).
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
15
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
16 There are two ways you can install protk_ (choose one):
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
17
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
18 1. **Manual Install:** Details on how to install protk_ manually are available here_.
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
19
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
20 2. **Use Docker:** These tools are 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.
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
21
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
22 .. _docker: https://www.docker.com/
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
23 .. _here: https://github.com/iracooke/protk/#galaxy-integration
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
24 .. _container: https://wiki.galaxyproject.org/Admin/Tools/Docker
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
25 __ container_
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
26
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
27
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
28 Further Info
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
29 ------------
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
30
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
31 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`__
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
32
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
33 .. _github: https://github.com/iracooke/protk-galaxytools
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
34 .. _issue: https://github.com/iracooke/protk-galaxytools/issues
28067ed4ea0e Docker support and update for protk 1.4
iracooke
parents:
diff changeset
35 __ issue_