annotate README.rst @ 17:868e75fc0f70 draft default tip

Export XML_ONLY variable
author iracooke
date Mon, 26 Oct 2015 22:04:43 -0400
parents d90c8bc10a9c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
1 TPP Prophets
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
2 ============
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
3
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
4 Galaxy wrappers for Peptide Prophet, iProphet and Protein Prophet
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
5
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
6 Requirements
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
7 ------------
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
8
d90c8bc10a9c 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.
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
10
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
11 .. _protk: https://github.com/iracooke/protk
d90c8bc10a9c 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
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
13
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
14 There are two ways you can satify these dependencies (choose one):
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
15
d90c8bc10a9c 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_.
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
17
d90c8bc10a9c 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.
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
19
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
20 .. _docker: https://www.docker.com/
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
21 .. _here: https://github.com/iracooke/protk/#galaxy-integration
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
22 .. _container: https://wiki.galaxyproject.org/Admin/Tools/Docker
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
23 __ container_
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
24
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
25
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
26 Further Info
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
27 ------------
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
28
d90c8bc10a9c 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`__
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
30
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
31 .. _github: https://github.com/iracooke/protk-galaxytools
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
32 .. _issue: https://github.com/iracooke/protk-galaxytools/issues
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
33 __ issue_
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
34
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
35 Please visit the TPP__ website for details of the various Prophet tools
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
36
d90c8bc10a9c Docker support and update for protk 1.4
iracooke
parents:
diff changeset
37 __ trans_proteomic_pipeline_