annotate README.rst @ 17:7990ee72821b draft

planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/msgfplus/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
author iracooke
date Tue, 20 Oct 2015 20:04:09 -0400
parents 6c751c59ce18
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
1 MS-GF+
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
2 ======
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
3
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
4 Galaxy wrapper for the `MS-GF+`__ tandem ms search tool
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
5
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
6 .. _msgfplus: http://proteomics.ucsd.edu/software-tools/ms-gf/
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
7 __ msgfplus_
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
8
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
9 Requirements
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
10 ------------
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
11
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
12 This package uses protk_, msgfplus_ and the `idconvert` tool from Proteowizard_ which need to be present in order for the tool to work.
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
13
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
14 .. _protk: https://github.com/iracooke/protk
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
15 .. _Proteowizard: http://proteowizard.sourceforge.net/
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
16
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
17
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
18 There are two ways you can satify these dependencies (choose one):
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
19
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
20 1. **Manual Install:** Details on how to install protk_, msgfplus_ and Proteowizard_ manually are available here_.
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
21
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
22 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.
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
23
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
24 .. _docker: https://www.docker.com/
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
25 .. _here: https://github.com/iracooke/protk/#galaxy-integration
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
26 .. _container: https://wiki.galaxyproject.org/Admin/Tools/Docker
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
27 __ container_
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
28
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
29
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
30 Further Info
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
31 ------------
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
32
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
33 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`__
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
34
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
35 .. _github: https://github.com/iracooke/protk-galaxytools
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
36 .. _issue: https://github.com/iracooke/protk-galaxytools/issues
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
37 __ issue_
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
38
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
39
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
40 Information on the MS-GF+ search tool itself can be found here_
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
41
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
42 .. _here: http://proteowizard.sourceforge.net/
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
43