annotate README.rst @ 10:b3427b77073e draft default tip

planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
author iracooke
date Tue, 20 Oct 2015 19:50:46 -0400
parents f567d1818b84
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
1 Mascot
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
2 ======
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
3
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
4 Galaxy wrapper for the Mascot_ tandem ms search tool and a tool to convert results to `pepXML`
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
5
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
6 .. _Mascot: http://www.matrixscience.com/
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
7
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
8 Requirements
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
9 ------------
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
10
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
11 This package uses protk_, and the trans_proteomic_pipeline_ which need to be present in order for the tool to work. In addition, you will need a working installation of Mascot_ which is commercial software.
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
12
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
13 .. _protk: https://github.com/iracooke/protk
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
14 .. _trans_proteomic_pipeline: http://tools.proteomecenter.org/wiki/index.php?title=Software:TPP
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
15
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
16
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
17 There are two ways you can satify these dependencies (choose one):
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
18
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
19 1. **Manual Install:** Details on how to install protk_, msgfplus_ and Proteowizard_ manually are available here_.
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
20
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
21 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.
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
22
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
23 .. _docker: https://www.docker.com/
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
24 .. _here: https://github.com/iracooke/protk/#galaxy-integration
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
25 .. _container: https://wiki.galaxyproject.org/Admin/Tools/Docker
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
26 __ container_
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
27
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
28
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
29 Further Info
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
30 ------------
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
31
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
32 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`__
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
33
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
34 .. _github: https://github.com/iracooke/protk-galaxytools
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
35 .. _issue: https://github.com/iracooke/protk-galaxytools/issues
f567d1818b84 Docker support and update for protk 1.4
iracooke
parents:
diff changeset
36 __ issue_