Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ddomingof committed Oct 8, 2018
1 parent 0a4d7b3 commit ec43d5f
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 12 deletions.
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ PathMe |build| |coverage| |docs| |zenodo|
=========================================
The primary goal of this package is to convert KEGG, Reactome, and WikiPathways (see References below) to Biological
Expression Language (BEL). PathMe is the continuation of the ComPath web application aimed at exploring, analyzing,
and curating pathway knowledge in a more simplistic gene-centric view. This different approach involves converting
all the pathways to BEL as a pivotal integration schema and evaluating consensus and gaps in pathway knowledge.
Additionally, ComPath Reloaded is complemented with PathMe, a web application that enables the exploration of all
the pathways from these resources using the mappings curated from ComPath.
and curating pathway knowledge in a gene-centric view. This different approach involves converting
all the pathways to BEL as a pivotal integration schema to evaluate pathway cross-talks and consensus across
multiple databases. Additionally, ComPath Reloaded is complemented with PathMe, a web application that enables the
exploration of all the pathways from these resources using the mappings curated from ComPath.

Installation |pypi_version| |python_versions| |pypi_license|
------------------------------------------------------------
Expand Down Expand Up @@ -135,4 +135,4 @@ WikiPathways
:alt: Apache-2.0

.. |zenodo| image:: https://zenodo.org/badge/146161418.svg
:target: https://zenodo.org/badge/latestdoi/146161418
:target: https://zenodo.org/badge/latestdoi/146161418
8 changes: 7 additions & 1 deletion docs/source/kegg.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
KEGG
====
.. automodule:: pathme.kegg
.. automodule:: pathme.kegg.convert_to_bel
:members:

.. automodule:: pathme.kegg.kegg_xml_parser
:members:

.. automodule:: pathme.kegg.utils
:members:
8 changes: 7 additions & 1 deletion docs/source/reactome.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
Reactome
========
.. automodule:: pathme.reactome
.. automodule:: pathme.reactome.convert_to_bel
:members:

.. automodule:: pathme.reactome.rdf_sparql
:members:

.. automodule:: pathme.reactome.utils
:members:
13 changes: 12 additions & 1 deletion docs/source/wikipathways.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
WikiPathways
============
.. automodule:: pathme.wikipathways
.. automodule:: pathme.wikipathways.convert_to_bel
:members:

.. automodule:: pathme.wikipathways.rdf_sparql
:members:

.. automodule:: pathme.wikipathways.utils
:members:

Custom parser
~~~~~~~~~~~~~
.. automodule:: pathme.wikipathways.json_rdf_parser
:members:
7 changes: 3 additions & 4 deletions src/pathme/__init__.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# -*- coding: utf-8 -*-

"""PathMe.
The goal of this package is to conduct a systematic comparison across three of the major pathway databases. PathMe does
that by converting KEGG, Reactome, and WikiPathways to Biological Expression Language (BEL).
"""The goal of this package is to facilitate the evaluation of pathway knowledge
across three of the major pathway databases by harmozing and consolidating different formats.
PathMe does that by converting KEGG, Reactome, and WikiPathways to Biological Expression Language (BEL).
Once the three databases are harmonized into BEL, we can evaluate the consensus and gaps in pathway knowledge.
For that, PathMe is complemented with a web application (`PathMe Viewer <https://github.com/ComPath/PathMe-Viewer>`_)
that enables the exploration of all the pathways from these three resources. PathMe is the follow-up of the ComPath web
Expand Down

0 comments on commit ec43d5f

Please sign in to comment.