Mercurial > repos > galaxyp > peptideshaker

annotate 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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
1 GalaxyP - PeptideShaker
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
2 =======================
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
3
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
4 - Home: <https://github.com/galaxyproteomics/tools-galaxyp/>
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
5 - Galaxy Tool Shed: <http://toolshed.g2.bx.psu.edu/view/galaxyp/peptideshaker>
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
6 - Tool ID: `peptideshaker`, `search_gui`
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
7
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
8
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
9 Description
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
10 -----------
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
11
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
12 Perform protein identification combining numerous search engines (using SearchGUI) followed by peptide and protein inference with PeptideShaker.
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
13
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
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.
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
15
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
16
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
17 Configuration
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
18 -------------
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
19
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
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:
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
21
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
22 export _JAVA_OPTIONS='-Xmx1500M'
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
23
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
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:
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
25
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
26 export _JAVA_OPTIONS='-Xmx1500M -XX:MaxPermSize=256M'
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
27
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
28 It is also possible to set this on a per tool basis using advanced features of the galaxy job config system.
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
29
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
30 Note:
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
31
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
32 - PeptideShaker may require xvfb to simulate an X environment if this is installed on a headless server.
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
33
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
34 See:
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
35
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
36 * <https://code.google.com/p/peptide-shaker/>
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
37 * <https://code.google.com/p/searchgui/>
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
38
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
39
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
40 GalaxyP Community
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
41 -----------------
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
42
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
43 Current governing community policies for GalaxyP_ and other information can be found at:
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
44
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
45 <https://github.com/galaxyproteomics>
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
46
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
47 .. _GalaxyP: https://github.com/galaxyproteomics/
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
48
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
49
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
50 License
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
51 -------
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
52
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
53 Copyright (c) 2014 Regents of the University of Minnesota and Authors listed below.
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
54
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
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.
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
56
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
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/>.
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
58
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
59 You can copy, modify, distribute and perform the work, even for commercial purposes, all without asking permission.
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
60
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
61
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
62 Contributing
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
63 ------------
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
64
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
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/>
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
66
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
67
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
68 Authors
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
69 -------
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
70
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
71 Authors and contributors:
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
72
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
73 * Bjoern Gruening <bjoern.gruening@gmail.com>
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
74 * Ira Cooke
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
75 * Cody Wang
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
76 * Fred Sadler
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
77 * John Chilton <jmchilton@gmail.com>
2cafc729b2ae planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit 0e976aeeed9d516e0ad4735dc847b1f2eba3532b
iracooke
parents:
diff changeset
78 * Minnesota Supercomputing Institute, Univeristy of Minnesota