annotate README.rst @ 9:da575eb4432d 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:51:45 -0400
parents 487533fa6990
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
1 Mascot
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
2 ======
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
3
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
4 Galaxy wrapper for the Mascot_ tandem ms search tool and a tool to convert results to `pepXML`
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
5
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
6 .. _Mascot: http://www.matrixscience.com/
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
7
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
8 Requirements
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
9 ------------
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
10
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
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.
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
12
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
13 .. _protk: https://github.com/iracooke/protk
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
14 .. _trans_proteomic_pipeline: http://tools.proteomecenter.org/wiki/index.php?title=Software:TPP
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
15
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
16
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
17 There are two ways you can satify these dependencies (choose one):
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
18
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
19 1. **Manual Install:** Details on how to install protk_, msgfplus_ and Proteowizard_ manually are available here_.
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
20
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
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.
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
22
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
23 .. _docker: https://www.docker.com/
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
24 .. _here: https://github.com/iracooke/protk/#galaxy-integration
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
25 .. _container: https://wiki.galaxyproject.org/Admin/Tools/Docker
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
26 __ container_
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
27
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
28
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
29 Further Info
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
30 ------------
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
31
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
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`__
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
33
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
34 .. _github: https://github.com/iracooke/protk-galaxytools
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
35 .. _issue: https://github.com/iracooke/protk-galaxytools/issues
487533fa6990 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/mascot/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302
iracooke
parents:
diff changeset
36 __ issue_