annotate README.rst @ 9:827f19088303 draft default tip

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