annotate README.rst @ 15:0faaab4f192a draft

planemo upload for repository https://github.com/iracooke/protk-galaxytools/tree/master/xtandem commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
author iracooke
date Tue, 20 Oct 2015 20:47:05 -0400
parents 9d6e0ad4d600
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
1 X!Tandem
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
2 ========
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
3
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
4 Galaxy wrapper for running the X!Tandem search engine and converting results to pepXML
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
5
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
6 Requirements
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
7 ------------
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
8
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
9 This package uses protk_ and the trans_proteomic_pipeline_ which need to be present in order for the tool to work.
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
10
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
11 .. _protk: https://github.com/iracooke/protk
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
12 .. _trans_proteomic_pipeline: http://tools.proteomecenter.org/wiki/index.php?title=Software:TPP
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
13
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
14 There are two ways you can satify these dependencies (choose one):
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
15
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
16 1. **Manual Install:** Details on how to install protk_ and the trans_proteomic_pipeline_ manually are available here_.
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
17
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
18 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.
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
19
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
20 .. _docker: https://www.docker.com/
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
21 .. _here: https://github.com/iracooke/protk/#galaxy-integration
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
22 .. _container: https://wiki.galaxyproject.org/Admin/Tools/Docker
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
23 __ container_
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
24
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
25
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
26 Further Info
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
27 ------------
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
28
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
29 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`__
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
30
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
31 .. _github: https://github.com/iracooke/protk-galaxytools
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
32 .. _issue: https://github.com/iracooke/protk-galaxytools/issues
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
33 __ issue_
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
34
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
35
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
36 Please visit the XTandem_ page on the GPM website for details of the search engine itself.
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
37
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
38 .. _XTandem: http://www.thegpm.org/tandem/
9d6e0ad4d600 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
39