Mercurial > repos > galaxyp > reactome_pathwaymatcher

annotate README.rst @ 0:1e38071ab9d5 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
author galaxyp
date Wed, 20 Jun 2018 14:20:53 -0400
parents
children ee1dfac35bb3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
1 PathwayMatcher
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
2 =======================
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
3
1e38071ab9d5 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/>
1e38071ab9d5 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>
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
6 - Tools ID: `pathwaymatcher`
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
7
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
8
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
9 Description
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
10 -----------
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
11
1e38071ab9d5 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.
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
13
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
14
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
15 General Requirements
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
16 --------------------
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
17
1e38071ab9d5 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:
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
19
1e38071ab9d5 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'
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
21
1e38071ab9d5 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:
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
23
1e38071ab9d5 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'
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
25
1e38071ab9d5 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.
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
27
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
28
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
29 License
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
30 -------
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
31
1e38071ab9d5 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.
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
33
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
34
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
35 Authors
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
36 -------
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
37
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
38 Authors and contributors:
1e38071ab9d5 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/pathwaymatcher commit c12a99d3da62c83b779175b3c9022e7d5622053a
galaxyp
parents:
diff changeset
39
1e38071ab9d5 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>
1e38071ab9d5 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>