Skip to main content

Tools for creating and working with network models of metabolism.

Project description

Welcome to MetworkPy

Metworkpy Logo

MetworkPy is a Python library containing tools for working with and analyzing metabolic networks. This functionality includes:

  • Generating network representations of Genome Scale Metabolic Networks (GSMMs)
  • Integrating gene expression data with GSMMs
  • Evaluating where the metabolism is most perturbed using divergence metrics

Documentation

Documentation can be found at https://metworkpy.readthedocs.io

Usage

MetworkPy can be installed with pip:

pip install metworkpy

The documentation includes some instructions for getting started. For an example of the usage of MetworkPy see the examples directory . For a more advanced example associated associated with the application note for MetworkPy (including some test data) see https://github.com/Ma-Lab-Seattle-Childrens-CGIDR/metworkpy_application_note.

Issues and Pull Requests

If you experience any problems while using MetworkPy (including the documentation), please create a GitHub issue in this repository. When creating an issue, a minimal reproducible example of the issue will make getting you help much easier. You can also create issues for any enhancements you would like to see in MetworkPy. Contributions are welcome! Please see the CONTRIBUTING.md for more information.

Licensing

This project makes use of the following external libraries:

The mutual information implementation where partially inspired by those found in the feature_selection module of scikit-learn, and the tests for those methods were adapted from those in scikit-learn, which is licensed under the BSD-3-Clause. Additionally, the implementation of the iMAT functionality was inspired by gembox (which uses a GPL-3.0-only license), and dexom-python (which uses the GPL-3.0-only license).

The permutation test implementation uses modified code from SciPy's stats module (licensed under the BSD-3-Clause, see above) for estimating the empirical p-value in line with Phipson, B., & Smyth, G. K. (2010).

References

iMAT References

  1. Shlomi T, et al. Network-based prediction of human tissue-specific metabolism, Nat. Biotechnol., 2008, vol. 26 (pg. 1003-1010)
  2. Hadas Zur, Eytan Ruppin, Tomer Shlomi, iMAT: an integrative metabolic analysis tool, Bioinformatics, Volume 26, Issue 24, December 2010, Pages 3140–3142, https://doi.org/10.1093/bioinformatics/btq602

Kullback-Leibler Divergence

  1. Q. Wang, S. R. Kulkarni and S. Verdu, "Divergence Estimation for Multidimensional Densities Via k-Nearest-Neighbor Distances," in IEEE Transactions on Information Theory, vol. 55, no. 5, pp. 2392-2405, May 2009, doi: 10.1109/TIT.2009.2016060.

Mutual Information

  1. Kraskov, A., Stögbauer, H., & Grassberger, P. (2004). Estimating mutual information. Physical Review E, 69(6), 066138.
  2. Ross, B. C. (2014). Mutual Information between Discrete and Continuous Data Sets. PLoS ONE, 9(2), e87357

Permutation Testing

  1. Phipson, B., & Smyth, G. K. (2010). Permutation p-values should never be zero: Calculating exact p-values when permutations are randomly drawn. Statistical Applications in Genetics and Molecular Biology, 9(1). https://doi.org/10.2202/1544-6115.1585

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

metworkpy-0.7.0.tar.gz (209.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

metworkpy-0.7.0-py3-none-any.whl (137.2 kB view details)

Uploaded Python 3

File details

Details for the file metworkpy-0.7.0.tar.gz.

File metadata

  • Download URL: metworkpy-0.7.0.tar.gz
  • Upload date:
  • Size: 209.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for metworkpy-0.7.0.tar.gz
Algorithm Hash digest
SHA256 092ecbe0140a4dca511d04b650f8e9238d7cc706f7c1751d406621869e42c917
MD5 0c44d1ba6550be0dcae70156939cc9af
BLAKE2b-256 c01294e84e055999a878f1e5a74e6971dace4aeb7d713ebb6d3181a846d6a7c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for metworkpy-0.7.0.tar.gz:

Publisher: build_and_publish.yml on Ma-Lab-Seattle-Childrens-CGIDR/metworkpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file metworkpy-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: metworkpy-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 137.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for metworkpy-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f22ccf82c4896ae6c581c17b82aa10995b4959b198db4e24f891a739f49930fa
MD5 785c872b5224dd08067f2b1c384167b3
BLAKE2b-256 18870496ed6b0c0bc0a934d52c2bb0aac7a5b9580ebe8d73cb0db78e9873464c

See more details on using hashes here.

Provenance

The following attestation bundles were made for metworkpy-0.7.0-py3-none-any.whl:

Publisher: build_and_publish.yml on Ma-Lab-Seattle-Childrens-CGIDR/metworkpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page