Mercurial > repos > iracooke > protk_proteogenomics

annotate README.rst @ 0:956bfab63005 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/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
author iracooke
date Tue, 20 Oct 2015 20:36:03 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
1 Protk Proteogenomics
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
2 ====================
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
3
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
4 Map peptides and proteins to genomic (or transcriptomic) coordinates
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
5
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
6 Requirements
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
7 ------------
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
8
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
9 This package uses protk_ and blast_ which need to be present in order for the tools to work.
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
10
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
11 .. _protk: https://github.com/iracooke/protk
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
12 .. _blast: https://toolshed.g2.bx.psu.edu/view/devteam/ncbi_blast_plus
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
13
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
14 When installing this package, if you instruct galaxy to install dependencies it will automatically install blast_ but installation of protk_ may require additional steps (see below).
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
15
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
16 There are two ways you can install protk_ (choose one):
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
17
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
18 1. **Manual Install:** Details on how to install protk_ manually are available here_.
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
19
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
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.
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
21
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
22 .. _docker: https://www.docker.com/
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
23 .. _here: https://github.com/iracooke/protk/#galaxy-integration
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
24 .. _container: https://wiki.galaxyproject.org/Admin/Tools/Docker
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
25 __ container_
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
26
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
27
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
28 Further Info
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
29 ------------
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
30
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
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`__
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
32
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
33 .. _github: https://github.com/iracooke/protk-galaxytools
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
34 .. _issue: https://github.com/iracooke/protk-galaxytools/issues
956bfab63005 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/protk-proteogenomics/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents:
diff changeset
35 __ issue_