Mercurial > repos > galaxyp > spectrast

annotate README.rst @ 0:c8895a92b74d draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
author galaxyp
date Thu, 29 Mar 2018 09:51:50 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
1 SpectraST
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
2 =========
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
3
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
4 Galaxy wrappers for SpectraST
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
5
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
6 These wrappers are experimental. The plan is to divide SpectraST into 3 tools, create, filter and search, each with its own wrapper
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
7
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
8 Requirements
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
9 ------------
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
10
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
11 This package uses protk_ and the trans_proteomic_pipeline_ which need to be present in order for the tool to work.
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
12
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
13 .. _protk: https://github.com/iracooke/protk
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
14 .. _trans_proteomic_pipeline: http://tools.proteomecenter.org/wiki/index.php?title=Software:TPP
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
15
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
16 There are two ways you can satify these dependencies (choose one):
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
17
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
18 1. **Manual Install:** Details on how to install protk_ and the trans_proteomic_pipeline_ manually are available here_.
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
19
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
20 2. **Use Docker:** These tools are designed to run inside a docker_ container. If your galaxy supports `running tools within a docker container`__ you don't need to worry about dependencies. Simply install and things should just work. The docker container itself is versioned and new versions of this tool will automatically download an update to the container if needed.
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
21
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
22 .. _docker: https://www.docker.com/
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
23 .. _here: https://github.com/iracooke/protk/#galaxy-integration
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
24 .. _container: https://wiki.galaxyproject.org/Admin/Tools/Docker
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
25 __ container_
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
26
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
27
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
28 Further Info
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
29 ------------
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
30
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
31 The source code for this tool and other protk galaxy tools is on github_. Please visit the github page to contribute to the project or to `report an issue`__
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
32
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
33 .. _github: https://github.com/iracooke/protk-galaxytools
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
34 .. _issue: https://github.com/iracooke/protk-galaxytools/issues
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
35 __ issue_
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
36
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
37 Please visit the SpectraST_ website for details of the SpectraST tool itself
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
38
c8895a92b74d planemo upload for repository https://github.com/galaxyproteomics/protk-galaxytools/tree/master/spectrast commit 34735d62618a252173e3c90436f240659484727a
galaxyp
parents:
diff changeset
39 .. _SpectraST: http://tools.proteomecenter.org/wiki/index.php?title=Software:SpectraST