comparison README.rst @ 1:fa76abf69433 draft

planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/peptideshaker commit e09348a0c372d4355c5dda6519e52ff17e0e8621-dirty
author jjohnson
date Fri, 08 Jun 2018 15:58:53 -0400
parents 8b99cb00e1c4
children eea7e945f479
comparison
equal deleted inserted replaced
0:8b99cb00e1c4 1:fa76abf69433
1 GalaxyP - PeptideShaker 1 GalaxyP - PeptideShaker
2 ======================= 2 =======================
3 3
4 - Home: <https://github.com/galaxyproteomics/tools-galaxyp/> 4 - Home: <https://github.com/galaxyproteomics/tools-galaxyp/>
5 - Galaxy Tool Shed: <http://toolshed.g2.bx.psu.edu/view/galaxyp/peptideshaker> 5 - Galaxy Tool Shed: <http://toolshed.g2.bx.psu.edu/view/galaxyp/peptideshaker>
6 - Tool ID: `peptideshaker`, `search_gui` 6 - Tools ID: `peptide_shaker`, `search_gui`
7 7
8 8
9 Description 9 Description
10 ----------- 10 -----------
11 11
12 Perform protein identification combining numerous search engines (using SearchGUI) followed by peptide and protein inference with PeptideShaker. 12 Perform protein identification combining numerous search engines (using SearchGUI) followed by peptide and protein inference with PeptideShaker.
13 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. 14 Includes tool wrappers for FastaCLI, IdentificationParametersCLI, SearchGUI and PeptideShaker.
15
16
17
18 FastaCLI adds decoy sequences to any fasta file.
19
20 IdentificationParametersCLI allows to create a compressed zip file with a parameters (par) file which can be (re)used later to parameterize SearchGUI or PeptideShaker, and the fasta file referred.
21
22 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.
23
24 This can then be fed to the PeptideShaker tool which merges the results and performs peptide and protein inference.
15 25
16 26
17 General Requirements 27 General Requirements
18 -------------------- 28 --------------------
19 29
29 39
30 MSAmanda on linux 40 MSAmanda on linux
31 ----------------- 41 -----------------
32 42
33 Running MS Amanda on Linux requires that you have Mono installed. Mono 3.2.1 or newer is required. If you install via the toolshed Mono should be installed automatically, however if this does not work you can install it manually. 43 Running MS Amanda on Linux requires that you have Mono installed. Mono 3.2.1 or newer is required. If you install via the toolshed Mono should be installed automatically, however if this does not work you can install it manually.
34 44
35 On ubuntu Mono can be installed as follows 45 On ubuntu Mono can be installed as follows
36 46
37 sudo apt-get install mono-runtime 47 sudo apt-get install mono-runtime
38 sudo apt-get install libmono-system-core4.0-cil 48 sudo apt-get install libmono-system-core4.0-cil
39 49
40 For more help on installing Mono please see http://www.mono-project.com/download. 50 For more help on installing Mono please see http://www.mono-project.com/download.
41 51
42 Note 52 Note
43 ---- 53 ----
44 54
45 - Requires Galaxy release v15.10 or later, which fixes the installation of package_peptideshaker_1_1 and provides a searchgui_archive datatype that includes a version 55 - Requires Galaxy release v16.01 or later.
46
47 - PeptideShaker may require xvfb to simulate an X environment if this is installed on a headless server.
48 56
49 See: 57 See:
50 58
51 * <https://code.google.com/p/peptide-shaker/> 59 * <http://compomics.github.io/projects/peptide-shaker.html/>
52 * <https://code.google.com/p/searchgui/> 60 * <http://compomics.github.io/projects/searchgui.html/>
53 61
54 62
55 Search GUI - Fixed and Variable Modifications 63 Search GUI - Fixed and Variable Modifications
56 ------------------------------------------- 64 -------------------------------------------
57 65
58 - Options for modifications are read from local data file: searchgui_mods.loc 66 - Options for modifications are read from local data file: searchgui_mods.loc
59 This is copied from searchgui_mods.loc.sample on the first installation. 67 This is copied from searchgui_mods.loc.sample on the first installation.
60 68
61 The modifications are from: https://github.com/compomics/compomics-utilities/blob/master/src/main/java/com/compomics/util/experiment/identification/search_parameters_cli/IdentificationParametersInputBean.java 69 The modifications are from: https://github.com/compomics/compomics-utilities/blob/master/src/main/java/com/compomics/util/experiment/identification/search_parameters_cli/IdentificationParametersInputBean.java
62 70
63 GalaxyP Community 71 GalaxyP Community
64 ----------------- 72 -----------------