Mercurial > repos > galaxyp > peptideshaker

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