Mercurial > repos > galaxyp > peptideshaker

comparison README.rst @ 20:2cafc729b2ae draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
author iracooke
date Sun, 31 May 2015 09:05:57 -0400
parents
children dfaea053e32f
comparison
equal deleted inserted replaced
19:7e61179c5952 20:2cafc729b2ae
1 GalaxyP - PeptideShaker
2 =======================
3
4 - Home: <https://github.com/galaxyproteomics/tools-galaxyp/>
5 - Galaxy Tool Shed: <http://toolshed.g2.bx.psu.edu/view/galaxyp/peptideshaker>
6 - Tool ID: `peptideshaker`, `search_gui`
7
8
9 Description
10 -----------
11
12 Perform protein identification combining numerous search engines (using SearchGUI) followed by peptide and protein inference with PeptideShaker.
13
14 Includes tool wrappers for SearchGUI and PeptideShaker. The SearchGUI tool takes any number of mgf files and performs searches on these. It creates a large zip archive with all search results, the original database and spectra. This can then be fed to the PeptideShaker tool which merges the results and performs peptide and protein inference.
15
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 On some systems you may also need to adjust the amount of memory available for class definitions in addition to the maximum heapspace. For example:
25
26 export _JAVA_OPTIONS='-Xmx1500M -XX:MaxPermSize=256M'
27
28 It is also possible to set this on a per tool basis using advanced features of the galaxy job config system.
29
30 Note:
31
32 - PeptideShaker may require xvfb to simulate an X environment if this is installed on a headless server.
33
34 See:
35
36 * <https://code.google.com/p/peptide-shaker/>
37 * <https://code.google.com/p/searchgui/>
38
39
40 GalaxyP Community
41 -----------------
42
43 Current governing community policies for GalaxyP_ and other information can be found at:
44
45 <https://github.com/galaxyproteomics>
46
47 .. _GalaxyP: https://github.com/galaxyproteomics/
48
49
50 License
51 -------
52
53 Copyright (c) 2014 Regents of the University of Minnesota and Authors listed below.
54
55 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.
56
57 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/>.
58
59 You can copy, modify, distribute and perform the work, even for commercial purposes, all without asking permission.
60
61
62 Contributing
63 ------------
64
65 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://github.com/galaxyproteomics/tools-galaxyp/>
66
67
68 Authors
69 -------
70
71 Authors and contributors:
72
73 * Bjoern Gruening <bjoern.gruening@gmail.com>
74 * Ira Cooke
75 * Cody Wang
76 * Fred Sadler
77 * John Chilton <jmchilton@gmail.com>
78 * Minnesota Supercomputing Institute, Univeristy of Minnesota