annotate README.md @ 16:186fdc4b3310 draft

Uploaded
author galaxyp
date Mon, 16 Sep 2013 17:32:18 -0400
parents 0578e296cab4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
1 Tool wrapper for SearchGUI + PeptideShaker. This tool takes any number
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
2 of mgf files and performs X! Tandem and OMSSA searches on these via
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
3 SearchGUI and merges the results using PeptideShaker.
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
4
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
5 For Galaxy-P we are installing this tool via CloudBioLinux
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
6 (https://github.com/jmchilton/cloudbiolinux/blob/proteomics/cloudbio/custom/bio_proteomics.py). While
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
7 this fabric script may not be exactly appropriate for your environment
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
8 it may serve as a template for how to install this software. In
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
9 particular these tools require CLI wrappers to be placed for
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
10 PeptideShaker and SearchGUI that can be installed as demostrated in
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
11 these fabric functions.
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
12
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
13 Note: Also SearchGUI requires a version greater than 1.12.2 which
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
14 contained several bugs preventing this from working on the
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
15 command-line and via Linux.
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
16
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
17 Also, PeptideShaker may require xvfb to simulate an X environment if
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
18 this is installed on a headless server.
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
19 # Obtaining Tools
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
20
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
21 Repositories for all Galaxy-P tools can be found at
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
22 https:/bitbucket.org/galaxyp/.
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
23
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
24 # Contact
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
25
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
26 Please send suggestions for improvements and bug reports to
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
27 jmchilton@gmail.com.
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
28
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
29 # License
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
30
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
31 All Galaxy-P tools are licensed under the Apache License Version 2.0
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
32 unless otherwise documented.
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
33
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
34 # Tool Versioning
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
35
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
36 Galaxy-P tools will have versions of the form X.Y.Z. Versions
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
37 differing only after the second decimal should be completely
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
38 compatible with each other. Breaking changes should result in an
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
39 increment of the number before and/or after the first decimal. All
0578e296cab4 Initial commit.
galaxyp
parents:
diff changeset
40 tools of version less than 1.0.0 should be considered beta.