risk-network 0.0.11__py3-none-any.whl → 0.0.12b1__py3-none-any.whl

risk_network-0.0.12b1.dist-info/METADATA

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: risk-network
+Version: 0.0.12b1
+Summary: A Python package for biological network analysis
+Author-email: Ira Horecka <ira89@icloud.com>
+License: GPL-3.0-or-later
+Project-URL: Homepage, https://github.com/riskportal/network
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ipywidgets
+Requires-Dist: leidenalg
+Requires-Dist: markov_clustering
+Requires-Dist: matplotlib
+Requires-Dist: networkx
+Requires-Dist: nltk
+Requires-Dist: numpy
+Requires-Dist: openpyxl
+Requires-Dist: pandas
+Requires-Dist: python-igraph
+Requires-Dist: python-louvain
+Requires-Dist: scikit-learn
+Requires-Dist: scipy
+Requires-Dist: statsmodels
+Requires-Dist: threadpoolctl
+Requires-Dist: tqdm
+Dynamic: license-file
+
+# RISK Network
+
+<p align="center">
+  <img src="https://i.imgur.com/8TleEJs.png" width="50%" />
+</p>
+
+<br>
+
+![Python](https://img.shields.io/badge/python-3.8%2B-yellow)
+[![pypiv](https://img.shields.io/pypi/v/risk-network.svg)](https://pypi.python.org/pypi/risk-network)
+![License](https://img.shields.io/badge/license-GPLv3-purple)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.xxxxxxx.svg)](https://doi.org/10.5281/zenodo.xxxxxxx)
+![Downloads](https://img.shields.io/pypi/dm/risk-network)
+![Tests](https://github.com/riskportal/network/actions/workflows/ci.yml/badge.svg)
+
+**RISK** (Regional Inference of Significant Kinships) is a next-generation tool for biological network annotation and visualization. RISK integrates community detection-based clustering, rigorous statistical enrichment analysis, and a modular framework to uncover biologically meaningful relationships and generate high-resolution visualizations. RISK supports diverse data formats and is optimized for large-scale network analysis, making it a valuable resource for researchers in systems biology and beyond.
+
+## Documentation and Tutorial
+
+Full documentation is available at:
+
+- **Docs:** [https://riskportal.github.io/network-tutorial](https://riskportal.github.io/network-tutorial)  
+- **Tutorial Jupyter Notebook Repository:** [https://github.com/riskportal/network-tutorial](https://github.com/riskportal/network-tutorial)
+
+## Installation
+
+RISK is compatible with Python 3.8 or later and runs on all major operating systems. To install the latest version of RISK, run:
+
+```bash
+pip install risk-network --upgrade
+```
+
+## Features
+
+- **Comprehensive Network Analysis**: Analyze biological networks (e.g., protein–protein interaction and genetic interaction networks) as well as non-biological networks.
+- **Advanced Clustering Algorithms**: Supports Louvain, Leiden, Markov Clustering, Greedy Modularity, Label Propagation, Spinglass, and Walktrap for identifying structured network regions.
+- **Flexible Visualization**: Produce customizable, high-resolution network visualizations with kernel density estimate overlays, adjustable node and edge attributes, and export options in SVG, PNG, and PDF formats.
+- **Efficient Data Handling**: Supports multiple input/output formats, including JSON, CSV, TSV, Excel, Cytoscape, and GPickle.
+- **Statistical Analysis**: Assess functional enrichment using hypergeometric, permutation (network-aware), binomial, chi-squared, Poisson, and z-score tests, ensuring statistical adaptability across datasets.
+- **Cross-Domain Applicability**: Suitable for network analysis across biological and non-biological domains, including social and communication networks.
+
+## Example Usage
+
+We applied RISK to a *Saccharomyces cerevisiae* protein–protein interaction network from Michaelis et al. (2023), filtering for proteins with six or more interactions to emphasize core functional relationships. RISK identified compact, statistically enriched clusters corresponding to biological processes such as ribosomal assembly and mitochondrial organization.
+
+[![Figure 1](https://i.imgur.com/lJHJrJr.jpeg)](https://i.imgur.com/lJHJrJr.jpeg)
+
+This figure highlights RISK’s capability to detect both established and novel functional modules within the yeast interactome.
+
+## Citation
+
+If you use RISK in your research, please cite:
+
+**Horecka et al.**, "RISK: a next-generation tool for biological network annotation and visualization", **Bioinformatics**, 2025. DOI: [10.1234/zenodo.xxxxxxx](https://doi.org/10.1234/zenodo.xxxxxxx)
+
+## Software Architecture and Implementation
+
+RISK features a streamlined, modular architecture designed to meet diverse research needs. RISK’s modular design enables users to run individual components—such as clustering, statistical testing, or visualization—independently or in combination, depending on the analysis workflow. It includes dedicated modules for:
+
+- **Data I/O**: Supports JSON, CSV, TSV, Excel, Cytoscape, and GPickle formats.
+- **Clustering**: Supports multiple clustering methods, including Louvain, Leiden, Markov Clustering, Greedy Modularity, Label Propagation, Spinglass, and Walktrap. Provides flexible distance metrics tailored to network structure.
+- **Statistical Analysis**: Provides a suite of tests for overrepresentation analysis of annotations.
+- **Visualization**: Offers customizable, high-resolution output in multiple formats, including SVG, PNG, and PDF.
+- **Configuration Management**: Centralized parameters in risk.params ensure reproducibility and easy tuning for large-scale analyses.
+
+## Performance and Efficiency
+
+Benchmarking results demonstrate that RISK efficiently scales to networks exceeding hundreds of thousands of edges, maintaining low execution times and optimal memory usage across statistical tests.
+
+## Contributing
+
+We welcome contributions from the community:
+
+- [Issues Tracker](https://github.com/riskportal/network/issues)
+- [Source Code](https://github.com/riskportal/network/tree/main/risk)
+
+## Support
+
+If you encounter issues or have suggestions for new features, please use the [Issues Tracker](https://github.com/riskportal/network/issues) on GitHub.
+
+## License
+
+RISK is open source under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).

risk_network-0.0.12b1.dist-info/RECORD

@@ -0,0 +1,40 @@
+risk/__init__.py,sha256=ADVxFWQawaQ0uFwnpUUmlwzs9FIxFA9tFem9_pB5rn4,127
+risk/risk.py,sha256=_Zs8cC4V0eqzfaMbq9M50ir815dbYS-oyTPlrySuMLw,1121
+risk/annotations/__init__.py,sha256=cW2qf4se_Ehmo69mZE3aKy_LzWlTnffcI8KOKqqCock,192
+risk/annotations/annotations.py,sha256=KtFyCiCnoAkhin3HKDBtkNcz5imjpysrmEfQKUwyqh8,14737
+risk/annotations/io.py,sha256=_VAr_6SqzrFzmYt75WZ029871EYlHrJ72yoo-kR5uBE,10748
+risk/annotations/nltk_setup.py,sha256=VRLXIxYRBEzTwAsOD2X48NjRAQJHPwqJPDjLGW6SZCY,3554
+risk/log/__init__.py,sha256=en-hKzuFtQWos4oZd8PxJ9u9Pe5bdihiqH9-qk_5ppw,217
+risk/log/console.py,sha256=PgjyEvyhYLUSHXPUKEqOmxsDsfrjPICIgqo_cAHq0N8,4575
+risk/log/parameters.py,sha256=yGbV5VWSgoTD5w9D3iC-McyOoAJioeuCwl2Z-T-951M,5808
+risk/neighborhoods/__init__.py,sha256=CNS0VNbh_IdxldXjDkPqeTrxgY4hqi_Tc_MTADW_tzQ,182
+risk/neighborhoods/api.py,sha256=ibU9uyOmIWVIjRnFIas77ylEo5cH2T78Bn4fZmUozT8,23355
+risk/neighborhoods/community.py,sha256=0YdTh6wgMLiGMdtlaD7Vu_uxOVoZ9vDBjxbkglkrTV8,17808
+risk/neighborhoods/domains.py,sha256=oveQhhhF-X5cef7PWGdAf1hp_e1fRTNAq_dgzkupzig,14790
+risk/neighborhoods/neighborhoods.py,sha256=DuItwOhLc7IuuEDqNuYgdDnvLaNVyc0J_2IvkcnD2IM,21675
+risk/neighborhoods/stats/__init__.py,sha256=1evLEAa7trCWj2DapCV4vW_f0zsyKHqTsn4--E_fDPg,306
+risk/neighborhoods/stats/tests.py,sha256=RMGEULBIDueqgl95_mz_8YJjayj__llpKr_gqpjSmFU,12107
+risk/neighborhoods/stats/permutation/__init__.py,sha256=V-uLSoi4SIPKjSRl7rhcDR4HJ4tquAn3QxNTXH9KzK8,169
+risk/neighborhoods/stats/permutation/permutation.py,sha256=YJ9bvQy6BNWje5UZrjeOfpBudE0i-G7eRcCkWvYDfcE,10695
+risk/neighborhoods/stats/permutation/test_functions.py,sha256=uppxrrlqSLOvZGCG67E1G8TpVPkGreU1T5quVCzq1PM,3149
+risk/network/__init__.py,sha256=C9GisdyJM7fizwUIipy1vC4lbry9ceqLn1iBcW0-mZg,34
+risk/network/io.py,sha256=KXtQPFXYMBe8QNZQtp75AJHzaQhzJX9au4ZrVCZhaJg,27886
+risk/network/graph/__init__.py,sha256=iG6IlE8xtAyF6_NuCBUpsJrjrjd1vsXO1Ajsr0K8EA0,46
+risk/network/graph/api.py,sha256=ThlQ3MCCa4EkDWfflY_RcBsK_ekxe-dyhkSLEY9-udo,8550
+risk/network/graph/graph.py,sha256=69frjpl2z7JjIyVqBhlOUzv4keDXOBDzwKcrCNS1KGM,12334
+risk/network/graph/stats.py,sha256=xITodchaF8Pgngynil_GM9IeMBtxuraPX-Gjp6WBEMY,7338
+risk/network/graph/summary.py,sha256=_3zuPFSDegti23uRpa24pbE6sUYCt7ucYQXtFNKMbX4,10277
+risk/network/plotter/__init__.py,sha256=9kdeONe8NaJvJ5FO7eOdZiobqL4CeR7q2MghG4z6Kt8,50
+risk/network/plotter/api.py,sha256=GFP0n_0-tSdCZQd6cuaH3w55953sXCR02nwyJhAEqK4,1789
+risk/network/plotter/canvas.py,sha256=U4u5XCER8k3rUB_au7YxB0S5yMDiFkz-6xHiaxdSGG0,13610
+risk/network/plotter/contour.py,sha256=Ybqfz2UJZ2Woe4J48UkMYxUbmGB4D3elyZJla2P5ohU,15505
+risk/network/plotter/labels.py,sha256=TJ67Oe4mN1ZPiCAUvbJESCcO3EkAg-l_ehy-rWBWOd8,46745
+risk/network/plotter/network.py,sha256=0VySlJ4n3tkHsOhVVSa3yiSppT8y1dmIwa-DhRn0tcM,14131
+risk/network/plotter/plotter.py,sha256=KJ_7Ye98ha6mchEaNY8kT0qCHAiGWZUzPiI3RCI9Wx0,5975
+risk/network/plotter/utils/colors.py,sha256=Pqa5pYZi8qdP9AsdXVY6u4a8sEKM3cF8gBP9TQwDTfI,19015
+risk/network/plotter/utils/layout.py,sha256=OPqV8jzV9dpnOhYU4SYMSfsIXalVzESrlBSI_Y43OGU,3640
+risk_network-0.0.12b1.dist-info/licenses/LICENSE,sha256=jOtLnuWt7d5Hsx6XXB2QxzrSe2sWWh3NgMfFRetluQM,35147
+risk_network-0.0.12b1.dist-info/METADATA,sha256=Lyrx0dcjEsfc-hC8GS82asYFs-BSySsTI1UFhKdoX4A,6667
+risk_network-0.0.12b1.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
+risk_network-0.0.12b1.dist-info/top_level.txt,sha256=NX7C2PFKTvC1JhVKv14DFlFAIFnKc6Lpsu1ZfxvQwVw,5
+risk_network-0.0.12b1.dist-info/RECORD,,

{risk_network-0.0.11.dist-info → risk_network-0.0.12b1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (76.0.0)
+Generator: setuptools (79.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

risk/network/geometry.py

@@ -1,150 +0,0 @@
-"""
-risk/network/geometry
-~~~~~~~~~~~~~~~~~~~~~
-"""
-
-import networkx as nx
-import numpy as np
-
-
-def assign_edge_lengths(
-    G: nx.Graph,
-    compute_sphere: bool = True,
-    surface_depth: float = 0.0,
-) -> nx.Graph:
-    """Assign edge lengths in the graph, optionally mapping nodes to a sphere.
-
-    Args:
-        G (nx.Graph): The input graph.
-        compute_sphere (bool): Whether to map nodes to a sphere. Defaults to True.
-        surface_depth (float): The surface depth for mapping to a sphere. Defaults to 0.0.
-
-    Returns:
-        nx.Graph: The graph with applied edge lengths.
-    """
-
-    def compute_distance_vectorized(coords, is_sphere):
-        """Compute distances between pairs of coordinates."""
-        u_coords, v_coords = coords[:, 0, :], coords[:, 1, :]
-        if is_sphere:
-            u_coords /= np.linalg.norm(u_coords, axis=1, keepdims=True)
-            v_coords /= np.linalg.norm(v_coords, axis=1, keepdims=True)
-            dot_products = np.einsum("ij,ij->i", u_coords, v_coords)
-            return np.arccos(np.clip(dot_products, -1.0, 1.0))
-        return np.linalg.norm(u_coords - v_coords, axis=1)
-
-    # Normalize graph coordinates
-    _normalize_graph_coordinates(G)
-
-    # Map nodes to sphere and adjust depth if required
-    if compute_sphere:
-        _map_to_sphere(G)
-        G_depth = _create_depth(G, surface_depth=surface_depth)
-    else:
-        G_depth = G
-
-    # Precompute edge coordinate arrays and compute distances in bulk
-    edge_data = np.array(
-        [
-            [
-                np.array(
-                    [G_depth.nodes[u]["x"], G_depth.nodes[u]["y"], G_depth.nodes[u].get("z", 0)]
-                ),
-                np.array(
-                    [G_depth.nodes[v]["x"], G_depth.nodes[v]["y"], G_depth.nodes[v].get("z", 0)]
-                ),
-            ]
-            for u, v in G_depth.edges
-        ]
-    )
-    # Compute distances
-    distances = compute_distance_vectorized(edge_data, compute_sphere)
-    # Assign distances back to the graph
-    for (u, v), distance in zip(G_depth.edges, distances):
-        G.edges[u, v]["length"] = distance
-
-    return G
-
-
-def _map_to_sphere(G: nx.Graph) -> None:
-    """Map the x and y coordinates of graph nodes onto a 3D sphere.
-
-    Args:
-        G (nx.Graph): The input graph with nodes having 'x' and 'y' coordinates.
-    """
-    # Extract x, y coordinates as a NumPy array
-    nodes = list(G.nodes)
-    xy_coords = np.array([[G.nodes[node]["x"], G.nodes[node]["y"]] for node in nodes])
-    # Normalize coordinates between [0, 1]
-    min_vals = xy_coords.min(axis=0)
-    max_vals = xy_coords.max(axis=0)
-    normalized_xy = (xy_coords - min_vals) / (max_vals - min_vals)
-    # Convert normalized coordinates to spherical coordinates
-    theta = normalized_xy[:, 0] * np.pi * 2
-    phi = normalized_xy[:, 1] * np.pi
-    # Compute 3D Cartesian coordinates
-    x = np.sin(phi) * np.cos(theta)
-    y = np.sin(phi) * np.sin(theta)
-    z = np.cos(phi)
-    # Assign coordinates back to graph nodes in bulk
-    xyz_coords = {node: {"x": x[i], "y": y[i], "z": z[i]} for i, node in enumerate(nodes)}
-    nx.set_node_attributes(G, xyz_coords)
-
-
-def _normalize_graph_coordinates(G: nx.Graph) -> None:
-    """Normalize the x and y coordinates of the nodes in the graph to the [0, 1] range.
-
-    Args:
-        G (nx.Graph): The input graph with nodes having 'x' and 'y' coordinates.
-    """
-    # Extract x, y coordinates from the graph nodes
-    xy_coords = np.array([[G.nodes[node]["x"], G.nodes[node]["y"]] for node in G.nodes()])
-    # Calculate min and max values for x and y
-    min_vals = np.min(xy_coords, axis=0)
-    max_vals = np.max(xy_coords, axis=0)
-    # Normalize the coordinates to [0, 1]
-    normalized_xy = (xy_coords - min_vals) / (max_vals - min_vals)
-    # Update the node coordinates with the normalized values
-    for i, node in enumerate(G.nodes()):
-        G.nodes[node]["x"], G.nodes[node]["y"] = normalized_xy[i]
-
-
-def _create_depth(G: nx.Graph, surface_depth: float = 0.0) -> nx.Graph:
-    """Adjust the 'z' attribute of each node based on the subcluster strengths and normalized surface depth.
-
-    Args:
-        G (nx.Graph): The input graph.
-        surface_depth (float): The maximum surface depth to apply for the strongest subcluster.
-
-    Returns:
-        nx.Graph: The graph with adjusted 'z' attribute for each node.
-    """
-    if surface_depth >= 1.0:
-        surface_depth -= 1e-6  # Cap the surface depth to prevent a value of 1.0
-
-    # Compute subclusters as connected components
-    connected_components = list(nx.connected_components(G))
-    subcluster_strengths = {}
-    max_strength = 0
-    # Precompute strengths and track the maximum strength
-    for component in connected_components:
-        size = len(component)
-        max_strength = max(max_strength, size)
-        for node in component:
-            subcluster_strengths[node] = size
-
-    # Avoid repeated lookups and computations by pre-fetching node data
-    nodes = list(G.nodes(data=True))
-    node_updates = {}
-    for node, attrs in nodes:
-        strength = subcluster_strengths[node]
-        normalized_surface_depth = (strength / max_strength) * surface_depth
-        x, y, z = attrs["x"], attrs["y"], attrs["z"]
-        norm = np.sqrt(x**2 + y**2 + z**2)
-        adjusted_z = z - (z / norm) * normalized_surface_depth
-        node_updates[node] = {"z": adjusted_z}
-
-    # Batch update node attributes
-    nx.set_node_attributes(G, node_updates)
-
-    return G

risk/stats/__init__.py

@@ -1,15 +0,0 @@
-"""
-risk/stats
-~~~~~~~~~~
-"""
-
-from risk.stats.permutation import compute_permutation_test
-from risk.stats.stat_tests import (
-    compute_binom_test,
-    compute_chi2_test,
-    compute_hypergeom_test,
-    compute_poisson_test,
-    compute_zscore_test,
-)
-
-from risk.stats.significance import calculate_significance_matrices

risk/stats/permutation/__init__.py

@@ -1,6 +0,0 @@
-"""
-risk/stats/permutation
-~~~~~~~~~~~~~~~~~~~~~~
-"""
-
-from risk.stats.permutation.permutation import compute_permutation_test