annotate README.rst @ 0:f66af2b04a98 draft

planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
author galaxyp
date Wed, 20 Jun 2018 14:21:10 -0400
parents
children 5d0c44bc354d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
1 PathwayMatcher
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
2 =======================
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
3
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
4 - Home: <https://github.com/LuisFranciscoHS/PathwayMatcher/>
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
5 - Galaxy Tool Shed: <http://toolshed.g2.bx.psu.edu/view/galaxyp/pathwaymatcher>
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
6 - Tools ID: `pathwaymatcher`
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
7
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
8
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
9 Description
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
10 -----------
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
11
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
12 PathwayMatcher is a software tool written in Java to search for pathways related to a list of proteins in Reactome.
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
13
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
14
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
15 General Requirements
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
16 --------------------
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
17
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
18 This tool requires a Java runtime 1.6 or greater to work. To avoid out of memory errors you should set the maximum heapspace for java processes as the default is most likely too small. For example, to set this in your shell:
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
19
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
20 export _JAVA_OPTIONS='-Xmx1500M'
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
21
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
22 On some systems you may also need to adjust the amount of memory available for class definitions in addition to the maximum heapspace. For example:
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
23
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
24 export _JAVA_OPTIONS='-Xmx1500M -XX:MaxPermSize=256M'
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
25
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
26 It is also possible to set this on a per tool basis using advanced features of the galaxy job config system.
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
27
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
28
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
29 License
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
30 -------
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
31
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
32 PathwayMatcher is a free open-source project, following an Apache License 2.0.
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
33
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
34
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
35 Authors
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
36 -------
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
37
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
38 Authors and contributors:
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
39
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
40 * Luis Francisco Hernández Sánchez <luis.sanchez@uib.no>
f66af2b04a98 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
41 * Carlos Horro Marcos <carlos.horro@uib.no>