annotate README.md @ 0:d4b6c9eae635 draft

Initial commit.
author galaxyp
date Fri, 10 May 2013 17:22:51 -0400
parents
children 8bac3cc5c5de
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
1 Tool wrapper for MaxQuant.
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
2
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
3 MaxQuant is a Windows only program and so you will likely need to
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
4 deploy this tool to run on a remote Windows system via the LWR
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
5 (https://lwr.readthedocs.org).
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
6
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
7 The sample mods file maxquant_mods.loc.sample corresponds to the
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
8 default modifications MaxQuant is configured with. The Galaxy-P
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
9 project uses a MaxQuant that has been extended with all of Unimod. To
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
10 modify MaxQuant in this fashion replace MaxQuant's modifications.xml
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
11 file with the extended_modifications.xml distributed with this tool
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
12 and configure Galaxy with the maxquant_mods.loc.sample.extended loc
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
13 file.# Obtaining Tools
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
14
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
15 Repositories for all Galaxy-P tools can be found at
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
16 https:/bitbucket.org/galaxyp/.
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
17
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
18 # Contact
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
19
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
20 Please send suggestions for improvements and bug reports to
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
21 jmchilton@gmail.com.
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
22
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
23 # License
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
24
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
25 All Galaxy-P tools are licensed under the Apache License Version 2.0
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
26 unless otherwise documented.
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
27
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
28 # Tool Versioning
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
29
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
30 Galaxy-P tools will have versions of the form X.Y.Z. Versions
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
31 differing only after the second decimal should be completely
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
32 compatible with each other. Breaking changes should result in an
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
33 increment of the number before and/or after the first decimal. All
d4b6c9eae635 Initial commit.
galaxyp
parents:
diff changeset
34 tools of version less than 1.0.0 should be considered beta.