comparison README.md @ 18:a5f9b959d5d1 draft

Uploaded
author iracooke
date Wed, 25 Jun 2014 11:49:45 -0400
parents
children
comparison
equal deleted inserted replaced
17:6cdbfdffb38e 18:a5f9b959d5d1
1 GalaxyP - PeptideShaker
2 =======================
3
4 * Home: <https://bitbucket.org/galaxyp/peptideshaker>
5 * Galaxy Tool Shed: <http://toolshed.g2.bx.psu.edu/view/galaxyp/peptideshaker>
6 * Tool ID: `peptideshaker`
7 * Tool Type: `default`
8
9
10 Description
11 -----------
12
13 Perform protein identification combining X! Tandem and OMSSA (using SearchGUI) and PeptideShaker pipeline.
14
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.
16
17 Configuration
18 -------------
19
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;
21
22 export _JAVA_OPTIONS='-Xmx1500M'
23
24 It is also possible to set this on a per tool basis using advanced features of the galaxy job config system
25
26 Note:
27
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.
29
30 - PeptideShaker may require xvfb to simulate an X environment if this is installed on a headless server.
31
32 See:
33
34 * <https://code.google.com/p/peptide-shaker/>
35 * <https://code.google.com/p/searchgui/>
36
37
38 GalaxyP Community
39 -----------------
40
41 Current governing community policies for [GalaxyP](https://bitbucket.org/galaxyp/) and other information can be found at:
42
43 <https://bitbucket.org/galaxyp/galaxyp>
44
45
46 License
47 -------
48
49 Copyright (c) 2014 Regents of the University of Minnesota and Authors listed below.
50
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.
52
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/>.
54
55 You can copy, modify, distribute and perform the work, even for commercial purposes, all without asking permission.
56
57
58 Contributing
59 ------------
60
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.
62
63
64 Authors
65 -------
66
67 Authors and contributors:
68
69 * Bjoern Gruening <bjoern.gruening@gmail.com>
70 * Ira Cooke
71 * Cody Wang
72 * Fred Sadler
73 * John Chilton <jmchilton@gmail.com>
74 * Minnesota Supercomputing Institute, Univeristy of Minnesota