pathme 0.1.13

Database Versions

PathMe currently uses the following versions of the databases:

• KEGG: Up-to-date (KEGG does not have tag its releases)

• Reactome: 67 Release

• WikiPathways: March 2020 Release

Citation

If you use PathMe in your work, please consider citing:

Installation

pathme can be directly installed from PyPi with pip:

$ python3 -m pip install pathme

To use the latest version install directly from GitHub:

$ python3 -m pip install git+https://github.com/PathwayMerger/PathMe.git

2. or in editable mode with:

$ git clone https://github.com/PathwayMerger/PathMe.git
$ cd pathme
$ python3 -m pip install -e .

How to Use

Before using PathMe, make sure you have installed and populated the Bio2BEL HGNC and Bio2BEL ChEBI databases (Simple run:”python3 -m bio2bel_hgnc populate” and “python3 -m bio2bel_chebi populate”) in your favourite terminal.

Each database has three main commands: download, bel, and summarize:

1. Download content

PathMe first requires to download the raw files from the original pathway databases. This can be accomplished by running the command (‘database’ can be either KEGG, Reactome, or WikiPathways). E.g., python3 -m pathme kegg download

$ python3 -m pathme <database> download

2. Generate BEL Graphs

Once the raw files are downloaded, you can run the following to command to generate BELGraphs that will be exported as Python pickles files for further analysis. Furthermore, the conversion to BEL can be tuned differently for each database by using specific commands. For example, KEGG parameters are shown when running “python3 -m pathme kegg bel –help”. Finally, please bear in mind that converting the Reactome files take up to 8 hours due to the large amount of its RDF file.

$ python3 -m pathme <database> bel

2. Summarize

Summarizes the result of the conversion to BEL.

$ python3 -m pathme <database> summarize

Advanced Parameters

KEGG Functionalities

The KEGG module of PathMe is able to handle KGML differently depending on the goal. By default, KEGG groups together the complex of nodes (e.g., gene families) into one node as it is depicted in the KEGG cartoons and represented in the KGML files. However, this behavior can be modified by adding the parameter –flatten=True in the exporting command. Example:

$ python3 -m pathme kegg bel --flatten

Export PathMe

Run the following command to see the different formats that you can export PathMe to (e.g., CX, SPIA, etc.):

$ python3 -m pathme export --help

Disclaimer

PathMe is a scientific software that has been developed in an academic capacity, and thus comes with no warranty or guarantee of maintenance, support, or back-up of data.

References