risk-network 0.0.9b46__tar.gz → 0.0.10__tar.gz

{risk_network-0.0.9b46 → risk_network-0.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: risk-network
-Version: 0.0.9b46
+Version: 0.0.10
 Summary: A Python package for biological network analysis
 Author: Ira Horecka
 Author-email: Ira Horecka <ira89@icloud.com>
@@ -726,92 +726,73 @@ Dynamic: requires-python
 ![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)
-![Platforms](https://img.shields.io/badge/platform-linux%20%7C%20macos%20%7C%20windows-lightgrey)
+![Tests](https://github.com/riskportal/network/actions/workflows/ci.yml/badge.svg)
 
-**RISK** (Regional Inference of Significant Kinships) is a next-generation tool designed to streamline the analysis of biological and non-biological networks. RISK enhances network analysis with its modular architecture, extensive file format support, and advanced clustering algorithms. It simplifies the creation of publication-quality figures, making it an important tool for researchers across disciplines.
+**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
 
-- **Documentation**: Comprehensive documentation is available [here](Documentation link).
-- **Tutorial**: An interactive Jupyter notebook tutorial can be found [here](https://github.com/riskportal/network-tutorial).
-We highly recommend new users to consult the documentation and tutorial early on to fully leverage RISK's capabilities.
+An interactive Jupyter notebook tutorial can be found [here](https://github.com/riskportal/network-tutorial). We highly recommend new users to consult the documentation and tutorial early on to fully utilize RISK's capabilities.
 
 ## Installation
 
-RISK is compatible with Python 3.8 and later versions and operates on all major operating systems. Install RISK via pip:
+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
+pip install risk-network --upgrade
 ```
 
 ## Features
 
-- **Comprehensive Network Analysis**: Analyze biological networks such as protein–protein interaction (PPI) and gene regulatory networks, as well as non-biological networks.
-- **Advanced Clustering Algorithms**: Utilize algorithms like Louvain, Markov Clustering, Spinglass, and more to identify key functional modules.
-- **Flexible Visualization**: Generate clear, publication-quality figures with customizable node and edge attributes, including colors, shapes, sizes, and labels.
-- **Efficient Data Handling**: Optimized for large datasets, supporting multiple file formats such as JSON, CSV, TSV, Excel, Cytoscape, and GPickle.
-- **Statistical Analysis**: Integrated statistical tests, including hypergeometric, permutation, and Poisson tests, to assess the significance of enriched regions.
+- **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, 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, revealing both established and novel functional relationships. The visualization below highlights key biological processes such as ribosomal assembly and mitochondrial organization.
+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.
 
-![RISK Main Figure](https://i.imgur.com/5OP3Hqe.jpeg)
+[![Figure 1](https://i.imgur.com/lJHJrJr.jpeg)](https://i.imgur.com/lJHJrJr.jpeg)
 
-RISK successfully detected both known and novel functional clusters within the yeast interactome. Clusters related to Golgi transport and actin nucleation were clearly defined and closely located, showcasing RISK's ability to map well-characterized interactions. Additionally, RISK identified links between mRNA processing pathways and vesicle trafficking proteins, consistent with recent studies demonstrating the role of vesicles in mRNA localization and stability.
+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 the following:
+If you use RISK in your research, please cite:
 
-**Horecka**, *et al.*, "RISK: a next-generation tool for biological network annotation and visualization", **[Journal Name]**, 2024. DOI: [10.1234/zenodo.xxxxxxx](https://doi.org/10.1234/zenodo.xxxxxxx)
+**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. Each module focuses on a specific task—such as network input/output, statistical analysis, or visualization—ensuring ease of adaptation and extension. This design enhances flexibility and reduces development overhead for users integrating RISK into their workflows.
+RISK features a streamlined, modular architecture designed to meet diverse research needs. It includes dedicated modules for:
 
-### Supported Data Formats
-
-- **Input/Output**: JSON, CSV, TSV, Excel, Cytoscape, GPickle.
-- **Visualization Outputs**: SVG, PNG, PDF.
-
-### Clustering Algorithms
-
-- **Available Algorithms**:
-  - Greedy Modularity
-  - Label Propagation
-  - Louvain
-  - Markov Clustering
-  - Spinglass
-  - Walktrap
-- **Distance Metrics**: Supports both spherical and Euclidean distance metrics.
-
-### Statistical Tests
-
-- **Hypergeometric Test**
-- **Permutation Test** (single- or multi-process modes)
-- **Poisson Test**
+- **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.
 
 ## Performance and Efficiency
 
-In benchmarking tests using the yeast interactome network, RISK demonstrated substantial improvements over previous tools in both computational performance and memory efficiency. RISK processed the dataset approximately **3.25 times faster**, reducing CPU time by **69%**, and required **25% less peak memory usage**, underscoring its efficient utilization of computational resources.
+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. Please use the following resources:
+We welcome contributions from the community:
 
-- [Issues Tracker](https://github.com/irahorecka/risk/issues)
-- [Source Code](https://github.com/irahorecka/risk/tree/main/risk)
+- [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/irahorecka/risk/issues) on GitHub.
+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 freely available as open-source software under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).
+RISK is open source under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).
 
 ---
 
-**Note**: For detailed documentation and to access the interactive tutorial, please visit the links provided in the [Documentation and Tutorial](#documentation-and-tutorial) section.
+**Note**: For detailed documentation and to access the interactive tutorial, please visit the links above.

risk_network-0.0.10/README.md

@@ -0,0 +1,83 @@
+# 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
+
+An interactive Jupyter notebook tutorial can be found [here](https://github.com/riskportal/network-tutorial). We highly recommend new users to consult the documentation and tutorial early on to fully utilize RISK's capabilities.
+
+## 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, 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. 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.
+
+## 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).
+
+---
+
+**Note**: For detailed documentation and to access the interactive tutorial, please visit the links above.

{risk_network-0.0.9b46 → risk_network-0.0.10}/risk/__init__.py

@@ -7,4 +7,4 @@ RISK: Regional Inference of Significant Kinships
 
 from risk.risk import RISK
 
-__version__ = "0.0.9-beta.46"
+__version__ = "0.0.10"

{risk_network-0.0.9b46 → risk_network-0.0.10}/risk/annotations/annotations.py

@@ -53,7 +53,7 @@ def ensure_nltk_resource(resource: str) -> None:
             print(f"Unzipped '{resource}' successfully.")
             break  # Stop after unzipping the first found ZIP.
 
-    # Final check: Try to load the resource one last time.
+    # Final check: Try to check resource one last time. If it fails, rai
     try:
         nltk.data.find(resource_path)
         print(f"Resource '{resource}' is now available.")
@@ -62,6 +62,11 @@ def ensure_nltk_resource(resource: str) -> None:
 
 
 # Ensure the NLTK stopwords and WordNet resources are available
+# punkt is known to have issues with the default download method, so we use a custom function if it fails
+try:
+    ensure_nltk_resource("punkt")
+except LookupError:
+    nltk.download("punkt")
 ensure_nltk_resource("stopwords")
 ensure_nltk_resource("wordnet")
 # Use NLTK's stopwords - load all languages

{risk_network-0.0.9b46 → risk_network-0.0.10}/risk/neighborhoods/domains.py

@@ -42,7 +42,7 @@ def define_domains(
     Args:
         top_annotations (pd.DataFrame): DataFrame of top annotations data for the network nodes.
         significant_neighborhoods_significance (np.ndarray): The binary significance matrix below alpha.
-        linkage_criterion (str): The clustering criterion for defining groups.
+        linkage_criterion (str): The clustering criterion for defining groups. Choose "off" to disable clustering.
         linkage_method (str): The linkage method for clustering. Choose "auto" to optimize.
         linkage_metric (str): The linkage metric for clustering. Choose "auto" to optimize.
         linkage_threshold (float, str): The threshold for clustering. Choose "auto" to optimize.
@@ -249,23 +249,21 @@ def _optimize_silhouette_across_linkage_and_metrics(
         # Some linkage methods and metrics may not work with certain data
         try:
             Z = linkage(m, method=method, metric=metric)
-        except (ValueError, LinAlgError):
-            # If linkage fails, set a default threshold (a float) and a very poor score
-            current_threshold = 0.0
-            score = -float("inf")
-        else:
-            # Only optimize silhouette score if the threshold is "auto"
             if linkage_threshold == "auto":
-                threshold, score = _find_best_silhouette_score(Z, m, metric, linkage_criterion)
+                try:
+                    threshold, score = _find_best_silhouette_score(Z, m, metric, linkage_criterion)
+                except (ValueError, LinAlgError):
+                    continue  # Skip to the next combination
                 current_threshold = threshold
             else:
-                # Use the provided threshold without optimization
                 score = silhouette_score(
                     m,
                     fcluster(Z, linkage_threshold * np.max(Z[:, 2]), criterion=linkage_criterion),
                     metric=metric,
                 )
                 current_threshold = linkage_threshold
+        except (ValueError, LinAlgError):
+            continue  # Skip to the next combination
 
         if score > best_overall_score:
             best_overall_score = score
@@ -290,7 +288,6 @@ def _find_best_silhouette_score(
     linkage_criterion: str,
     lower_bound: float = 0.001,
     upper_bound: float = 1.0,
-    resolution: float = 0.001,
 ) -> Tuple[float, float]:
     """Find the best silhouette score using binary search.
 
@@ -301,7 +298,6 @@ def _find_best_silhouette_score(
         linkage_criterion (str): Clustering criterion.
         lower_bound (float, optional): Lower bound for search. Defaults to 0.001.
         upper_bound (float, optional): Upper bound for search. Defaults to 1.0.
-        resolution (float, optional): Desired resolution for the best threshold. Defaults to 0.001.
 
     Returns:
         Tuple[float, float]:
@@ -310,6 +306,7 @@ def _find_best_silhouette_score(
     """
     best_score = -np.inf
     best_threshold = None
+    minimum_linkage_threshold = 1e-6
 
     # Test lower bound
     max_d_lower = np.max(Z[:, 2]) * lower_bound
@@ -338,7 +335,7 @@ def _find_best_silhouette_score(
         lower_bound = (lower_bound + upper_bound) / 2
 
     # Binary search loop
-    while upper_bound - lower_bound > resolution:
+    while upper_bound - lower_bound > minimum_linkage_threshold:
         mid_threshold = (upper_bound + lower_bound) / 2
         max_d_mid = np.max(Z[:, 2]) * mid_threshold
         clusters_mid = fcluster(Z, max_d_mid, criterion=linkage_criterion)

{risk_network-0.0.9b46 → risk_network-0.0.10}/risk_network.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: risk-network
-Version: 0.0.9b46
+Version: 0.0.10
 Summary: A Python package for biological network analysis
 Author: Ira Horecka
 Author-email: Ira Horecka <ira89@icloud.com>
@@ -726,92 +726,73 @@ Dynamic: requires-python
 ![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)
-![Platforms](https://img.shields.io/badge/platform-linux%20%7C%20macos%20%7C%20windows-lightgrey)
+![Tests](https://github.com/riskportal/network/actions/workflows/ci.yml/badge.svg)
 
-**RISK** (Regional Inference of Significant Kinships) is a next-generation tool designed to streamline the analysis of biological and non-biological networks. RISK enhances network analysis with its modular architecture, extensive file format support, and advanced clustering algorithms. It simplifies the creation of publication-quality figures, making it an important tool for researchers across disciplines.
+**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
 
-- **Documentation**: Comprehensive documentation is available [here](Documentation link).
-- **Tutorial**: An interactive Jupyter notebook tutorial can be found [here](https://github.com/riskportal/network-tutorial).
-We highly recommend new users to consult the documentation and tutorial early on to fully leverage RISK's capabilities.
+An interactive Jupyter notebook tutorial can be found [here](https://github.com/riskportal/network-tutorial). We highly recommend new users to consult the documentation and tutorial early on to fully utilize RISK's capabilities.
 
 ## Installation
 
-RISK is compatible with Python 3.8 and later versions and operates on all major operating systems. Install RISK via pip:
+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
+pip install risk-network --upgrade
 ```
 
 ## Features
 
-- **Comprehensive Network Analysis**: Analyze biological networks such as protein–protein interaction (PPI) and gene regulatory networks, as well as non-biological networks.
-- **Advanced Clustering Algorithms**: Utilize algorithms like Louvain, Markov Clustering, Spinglass, and more to identify key functional modules.
-- **Flexible Visualization**: Generate clear, publication-quality figures with customizable node and edge attributes, including colors, shapes, sizes, and labels.
-- **Efficient Data Handling**: Optimized for large datasets, supporting multiple file formats such as JSON, CSV, TSV, Excel, Cytoscape, and GPickle.
-- **Statistical Analysis**: Integrated statistical tests, including hypergeometric, permutation, and Poisson tests, to assess the significance of enriched regions.
+- **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, 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, revealing both established and novel functional relationships. The visualization below highlights key biological processes such as ribosomal assembly and mitochondrial organization.
+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.
 
-![RISK Main Figure](https://i.imgur.com/5OP3Hqe.jpeg)
+[![Figure 1](https://i.imgur.com/lJHJrJr.jpeg)](https://i.imgur.com/lJHJrJr.jpeg)
 
-RISK successfully detected both known and novel functional clusters within the yeast interactome. Clusters related to Golgi transport and actin nucleation were clearly defined and closely located, showcasing RISK's ability to map well-characterized interactions. Additionally, RISK identified links between mRNA processing pathways and vesicle trafficking proteins, consistent with recent studies demonstrating the role of vesicles in mRNA localization and stability.
+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 the following:
+If you use RISK in your research, please cite:
 
-**Horecka**, *et al.*, "RISK: a next-generation tool for biological network annotation and visualization", **[Journal Name]**, 2024. DOI: [10.1234/zenodo.xxxxxxx](https://doi.org/10.1234/zenodo.xxxxxxx)
+**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. Each module focuses on a specific task—such as network input/output, statistical analysis, or visualization—ensuring ease of adaptation and extension. This design enhances flexibility and reduces development overhead for users integrating RISK into their workflows.
+RISK features a streamlined, modular architecture designed to meet diverse research needs. It includes dedicated modules for:
 
-### Supported Data Formats
-
-- **Input/Output**: JSON, CSV, TSV, Excel, Cytoscape, GPickle.
-- **Visualization Outputs**: SVG, PNG, PDF.
-
-### Clustering Algorithms
-
-- **Available Algorithms**:
-  - Greedy Modularity
-  - Label Propagation
-  - Louvain
-  - Markov Clustering
-  - Spinglass
-  - Walktrap
-- **Distance Metrics**: Supports both spherical and Euclidean distance metrics.
-
-### Statistical Tests
-
-- **Hypergeometric Test**
-- **Permutation Test** (single- or multi-process modes)
-- **Poisson Test**
+- **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.
 
 ## Performance and Efficiency
 
-In benchmarking tests using the yeast interactome network, RISK demonstrated substantial improvements over previous tools in both computational performance and memory efficiency. RISK processed the dataset approximately **3.25 times faster**, reducing CPU time by **69%**, and required **25% less peak memory usage**, underscoring its efficient utilization of computational resources.
+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. Please use the following resources:
+We welcome contributions from the community:
 
-- [Issues Tracker](https://github.com/irahorecka/risk/issues)
-- [Source Code](https://github.com/irahorecka/risk/tree/main/risk)
+- [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/irahorecka/risk/issues) on GitHub.
+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 freely available as open-source software under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).
+RISK is open source under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).
 
 ---
 
-**Note**: For detailed documentation and to access the interactive tutorial, please visit the links provided in the [Documentation and Tutorial](#documentation-and-tutorial) section.
+**Note**: For detailed documentation and to access the interactive tutorial, please visit the links above.

risk_network-0.0.9b46/README.md

@@ -1,102 +0,0 @@
-# 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)
-![Platforms](https://img.shields.io/badge/platform-linux%20%7C%20macos%20%7C%20windows-lightgrey)
-
-**RISK** (Regional Inference of Significant Kinships) is a next-generation tool designed to streamline the analysis of biological and non-biological networks. RISK enhances network analysis with its modular architecture, extensive file format support, and advanced clustering algorithms. It simplifies the creation of publication-quality figures, making it an important tool for researchers across disciplines.
-
-## Documentation and Tutorial
-
-- **Documentation**: Comprehensive documentation is available [here](Documentation link).
-- **Tutorial**: An interactive Jupyter notebook tutorial can be found [here](https://github.com/riskportal/network-tutorial).
-We highly recommend new users to consult the documentation and tutorial early on to fully leverage RISK's capabilities.
-
-## Installation
-
-RISK is compatible with Python 3.8 and later versions and operates on all major operating systems. Install RISK via pip:
-
-```bash
-pip install risk-network
-```
-
-## Features
-
-- **Comprehensive Network Analysis**: Analyze biological networks such as protein–protein interaction (PPI) and gene regulatory networks, as well as non-biological networks.
-- **Advanced Clustering Algorithms**: Utilize algorithms like Louvain, Markov Clustering, Spinglass, and more to identify key functional modules.
-- **Flexible Visualization**: Generate clear, publication-quality figures with customizable node and edge attributes, including colors, shapes, sizes, and labels.
-- **Efficient Data Handling**: Optimized for large datasets, supporting multiple file formats such as JSON, CSV, TSV, Excel, Cytoscape, and GPickle.
-- **Statistical Analysis**: Integrated statistical tests, including hypergeometric, permutation, and Poisson tests, to assess the significance of enriched regions.
-- **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, revealing both established and novel functional relationships. The visualization below highlights key biological processes such as ribosomal assembly and mitochondrial organization.
-
-![RISK Main Figure](https://i.imgur.com/5OP3Hqe.jpeg)
-
-RISK successfully detected both known and novel functional clusters within the yeast interactome. Clusters related to Golgi transport and actin nucleation were clearly defined and closely located, showcasing RISK's ability to map well-characterized interactions. Additionally, RISK identified links between mRNA processing pathways and vesicle trafficking proteins, consistent with recent studies demonstrating the role of vesicles in mRNA localization and stability.
-
-## Citation
-
-If you use RISK in your research, please cite the following:
-
-**Horecka**, *et al.*, "RISK: a next-generation tool for biological network annotation and visualization", **[Journal Name]**, 2024. 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. Each module focuses on a specific task—such as network input/output, statistical analysis, or visualization—ensuring ease of adaptation and extension. This design enhances flexibility and reduces development overhead for users integrating RISK into their workflows.
-
-### Supported Data Formats
-
-- **Input/Output**: JSON, CSV, TSV, Excel, Cytoscape, GPickle.
-- **Visualization Outputs**: SVG, PNG, PDF.
-
-### Clustering Algorithms
-
-- **Available Algorithms**:
-  - Greedy Modularity
-  - Label Propagation
-  - Louvain
-  - Markov Clustering
-  - Spinglass
-  - Walktrap
-- **Distance Metrics**: Supports both spherical and Euclidean distance metrics.
-
-### Statistical Tests
-
-- **Hypergeometric Test**
-- **Permutation Test** (single- or multi-process modes)
-- **Poisson Test**
-
-## Performance and Efficiency
-
-In benchmarking tests using the yeast interactome network, RISK demonstrated substantial improvements over previous tools in both computational performance and memory efficiency. RISK processed the dataset approximately **3.25 times faster**, reducing CPU time by **69%**, and required **25% less peak memory usage**, underscoring its efficient utilization of computational resources.
-
-## Contributing
-
-We welcome contributions from the community. Please use the following resources:
-
-- [Issues Tracker](https://github.com/irahorecka/risk/issues)
-- [Source Code](https://github.com/irahorecka/risk/tree/main/risk)
-
-## Support
-
-If you encounter issues or have suggestions for new features, please use the [Issues Tracker](https://github.com/irahorecka/risk/issues) on GitHub.
-
-## License
-
-RISK is freely available as open-source software under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).
-
----
-
-**Note**: For detailed documentation and to access the interactive tutorial, please visit the links provided in the [Documentation and Tutorial](#documentation-and-tutorial) section.