annotate README.md @ 18:a5f9b959d5d1 draft

Uploaded
author iracooke
date Wed, 25 Jun 2014 11:49:45 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
1 GalaxyP - PeptideShaker
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
2 =======================
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
3
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
4 * Home: <https://bitbucket.org/galaxyp/peptideshaker>
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
5 * Galaxy Tool Shed: <http://toolshed.g2.bx.psu.edu/view/galaxyp/peptideshaker>
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
6 * Tool ID: `peptideshaker`
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
7 * Tool Type: `default`
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
8
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
9
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
10 Description
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
11 -----------
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
12
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
13 Perform protein identification combining X! Tandem and OMSSA (using SearchGUI) and PeptideShaker pipeline.
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
14
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
15 Tool wrapper for SearchGUI and PeptideShaker. This tool takes any number of mgf files and performs X! Tandem and OMSSA searches on these via SearchGUI and merges the results using PeptideShaker.
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
16
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
17 Configuration
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
18 -------------
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
19
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
20 This tool requires a Java runtime 1.6 or greater to work. To avoid out of memory errors you should set the maximum heapspace for java processes as the default is most likely too small. For example, to set this in your shell;
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
21
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
22 export _JAVA_OPTIONS='-Xmx1500M'
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
23
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
24 It is also possible to set this on a per tool basis using advanced features of the galaxy job config system
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
25
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
26 Note:
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
27
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
28 - SearchGUI requires a version greater than 1.12.2 which contained several bugs preventing this from working on the command-line and via Linux.
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
29
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
30 - PeptideShaker may require xvfb to simulate an X environment if this is installed on a headless server.
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
31
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
32 See:
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
33
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
34 * <https://code.google.com/p/peptide-shaker/>
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
35 * <https://code.google.com/p/searchgui/>
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
36
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
37
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
38 GalaxyP Community
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
39 -----------------
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
40
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
41 Current governing community policies for [GalaxyP](https://bitbucket.org/galaxyp/) and other information can be found at:
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
42
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
43 <https://bitbucket.org/galaxyp/galaxyp>
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
44
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
45
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
46 License
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
47 -------
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
48
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
49 Copyright (c) 2014 Regents of the University of Minnesota and Authors listed below.
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
50
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
51 To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
52
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
53 You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see <https://creativecommons.org/publicdomain/zero/1.0/>.
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
54
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
55 You can copy, modify, distribute and perform the work, even for commercial purposes, all without asking permission.
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
56
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
57
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
58 Contributing
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
59 ------------
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
60
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
61 Contributions to this repository are reviewed through pull requests. If you would like your work acknowledged, please also add yourself to the Authors section. If your pull request is accepted, you will also be acknowledged in <https://bitbucket.org/galaxyp/galaxyp/CONTRIBUTORS.md> unless you opt-out.
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
62
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
63
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
64 Authors
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
65 -------
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
66
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
67 Authors and contributors:
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
68
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
69 * Bjoern Gruening <bjoern.gruening@gmail.com>
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
70 * Ira Cooke
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
71 * Cody Wang
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
72 * Fred Sadler
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
73 * John Chilton <jmchilton@gmail.com>
a5f9b959d5d1 Uploaded
iracooke
parents:
diff changeset
74 * Minnesota Supercomputing Institute, Univeristy of Minnesota