Skip to main content

Package to extract, visualize, convert and study interactions from database into executable activity flow based model

Project description

NeKo Logo
Tests Documentation

Neko is a Python package for extracting, visualizing, converting, and studying interactions from databases into executable activity flow-based models. It’s built on top of Omnipath, Pypath, and Atopo.

Note: Neko is currently in development and approaching its final stages. It is available on pip under the name “nekomata”.

Features

  • Network creation and manipulation

  • Connection of nodes and subnetworks

  • Gene-to-phenotype mapping

  • Network visualization

  • Interaction database integration

Installation

NeKo is still in its alpha version. You can install it from PyPI and also install the necessary external dependencies.

  1. Install `NeKo` from PyPI:

    First, install the main package from PyPI (nekomata, do not confuse with pip install neko or pip install pyneko, those are other packages):

    pip install nekomata
  2. Install External Dependencies:

    NeKo requires some external dependencies that are not available on PyPI. To install these dependencies, run:

    pip install -r https://raw.githubusercontent.com/sysbio-curie/Neko/main/requirements.txt

This two-step process will install both the core NeKo package and its external dependencies.

Installation from Source

For the latest development version, you can still clone the repository and install directly from the source:

git clone https://github.com/sysbio-curie/Neko.git
cd Neko
pip install .
pip install -r requirements.txt

This will give you the latest version of NeKo (not officially released, so be aware there could be some bugs) along with the necessary external dependencies.

Documentation

For full documentation, including API reference and detailed tutorials, visit our GitHub Pages documentation.

Jupyter Notebooks

We provide a comprehensive set of Jupyter notebooks that offer a detailed and user-friendly explanation of the package. These notebooks cover all modules of NeKo and provide a complete overview of how to use the package:

  1. Usage

  2. Build network using user-defined resources

  3. Stepwise connection: a focus on the INE algorithm

  4. Connect to upstream components

  5. Build network based on kinase-phosphosite interactions

  6. Connect to downstream Gene Ontology terms.

  7. Map tissue expression

  8. Network comparison

  9. Re-creating famous pathways from SIGNOR and WIKIPATHWAYS using NeKo

You can find these notebooks in the notebooks directory of the repository.

Acknowledgements

This project is a collaborative effort with Dénes Turei and Asmund Flobak.

Current contributors: Marco Ruscone, Eirini Tsirvouli, Andrea Checcoli, Dénes Turei.

version 0.9.4

  • Network creation and manipulation: The package allows for the creation of a network of nodes and edges, with various methods for enrichment analysis. This includes adding and removing nodes and edges, loading a network from a SIF (Simple Interaction Format) file, and adding paths to the edge list of the network.

  • Database integration: The package provides methods to integrate interactions from databases such as Omnipath, Signor, HURI and others. The user can also integrate personal resource to mine for interactions.

  • Database translation: The package provides methods to convert the identifiers of a database storing edges list, into Uniprot.

  • Connection of nodes: The package provides several methods to connect nodes in the network. This includes connecting all nodes, connecting a subgroup of nodes, connecting all nodes of a network object, and connecting subcomponents of a network object.

  • Connection of genes to phenotype: The package provides a method to connect genes to a phenotype based on provided parameters. This includes retrieving phenotype markers, identifying unique Uniprot genes, and connecting them to the network. There is also an option to compress the network by substituting specified genes with the phenotype name.

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

nekomata-0.9.5.tar.gz (55.7 kB view details)

Uploaded Source

Built Distribution

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

nekomata-0.9.5-py3-none-any.whl (63.9 kB view details)

Uploaded Python 3

File details

Details for the file nekomata-0.9.5.tar.gz.

File metadata

  • Download URL: nekomata-0.9.5.tar.gz
  • Upload date:
  • Size: 55.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.5 Linux/6.5.0-1023-oem

File hashes

Hashes for nekomata-0.9.5.tar.gz
Algorithm Hash digest
SHA256 3bd5c4fe4be9586c1cfc214575ba0f17d81cb23c2c3b750d49c4bdf7fb742da9
MD5 367eae188687a70ce144597d1a7d2a78
BLAKE2b-256 49706e432129aef297eadf0ec6ca8f4a1160d3131ff243b0f53d6ac160bca974

See more details on using hashes here.

File details

Details for the file nekomata-0.9.5-py3-none-any.whl.

File metadata

  • Download URL: nekomata-0.9.5-py3-none-any.whl
  • Upload date:
  • Size: 63.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.5 Linux/6.5.0-1023-oem

File hashes

Hashes for nekomata-0.9.5-py3-none-any.whl
Algorithm Hash digest
SHA256 3b0c6754899f4eb63385d3ac8b7cfc82a802ebb00cdd93170c9020ee126c7c55
MD5 c1039386e163176362b601e2d88fbfe8
BLAKE2b-256 6b7f2553c5ab0c2f916d194b399b56fa890319d42525475602ad9a860d4f5c4a

See more details on using hashes here.

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