annotate README.md @ 0:59e5d8c53c81 draft

Uploaded
author galaxyp
date Wed, 19 Dec 2012 00:27:24 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
1 # ms2preproc
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
2
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
3 This repository contains a tool wrapper for ms2preproc.
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
4
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
5 http://hci.iwr.uni-heidelberg.de/MIP/Software/ms2preproc.php
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
6
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
7 This tool requires Galaxy to be equipped with common proteomic
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
8 datatypes. These can be obtained by installing Ira Cooke's ProtK via
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
9 the tool shed or merging the changesets from the following repository
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
10 into your Galaxy instance:
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
11
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
12 https://bitbucket.org/galaxyp/galaxy-dist-proteomics
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
13
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
14 # Installing
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
15
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
16 This tool wrapper requires ms2preproc to be installed.
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
17
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
18 For Galaxy-P we are installing this tool via CloudBioLinux
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
19 (https://github.com/jmchilton/cloudbiolinux/blob/proteomics/cloudbio/custom/bio_proteomics.py). While
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
20 this fabric script may not be exactly appropriate for your environment
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
21 it may serve as a template for how to install this software.
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
22
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
23 # Obtaining Tools
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
24
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
25 Repositories for all Galaxy-P tools can be found at
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
26 https:/bitbucket.org/galaxyp/.
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
27
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
28 # Contact
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
29
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
30 Please send suggestions for improvements and bug reports to
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
31 jmchilton@gmail.com.
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
32
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
33 # License
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
34
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
35 All Galaxy-P tools are licensed under the Apache License Version 2.0
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
36 unless otherwise documented.
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
37
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
38 # Tool Versioning
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
39
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
40 Galaxy-P tools will have versions of the form X.Y.Z. Versions
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
41 differing only after the second decimal should be completely
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
42 compatible with each other. Breaking changes should result in an
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
43 increment of the number before and/or after the first decimal. All
59e5d8c53c81 Uploaded
galaxyp
parents:
diff changeset
44 tools of version less than 1.0.0 should be considered beta.