Merge branch 'main' of https://github.com/Multiomics-Analytics-Group/abaco

Author: angelphanth

README.md

@@ -1,7 +1,5 @@
-# ABaCo
-![img](https://raw.githubusercontent.com/Multiomics-Analytics-Group/abaco/refs/heads/main/docs/figures/overview.png)
+# ![ABaCo Logg](https://raw.githubusercontent.com/Multiomics-Analytics-Group/abaco/HEAD/docs/images/logo/abaco_logo.svg)
 
-<h1 align="center">ABaCo</h1>
 <p align="center"><em>Batch Effect Correction framework for metagenomic data</em></p>
 
 <p align="center">
@@ -25,6 +23,10 @@
 
 The integration of metagenomic data from multiple studies and experimental conditions is essential to understand the interactions between microbial communities in complex biological systems, but the inherent diversity and biological complexity pose methodological challenges that require refined strategies for atlas-level integration. ABaCo, a family of generative models based on Variational Autoencoders (VAEs) combined with an adversarial training, aim for the integration of metagenomic data from different studies by minimizing technical heterogeneity conserving biological significance. The VAE encodes the data into a latent space, while the discriminator is trained to detect the provenance of the data, eliminating variability associated with its origin; concurrently, the data is modeled using distributions suitable for raw counts, and the latent space follows a clustering prior to ensure biological conservation.
 
+An overview of the ABaCo workflow is shown in the figure below:
+
+![ABaCo Abstract](https://raw.githubusercontent.com/Multiomics-Analytics-Group/abaco/HEAD/docs/images/abaco_overview.png)
+
 ## Table of Contents
 
 - [Installation](#installation)
@@ -42,9 +44,12 @@ pip install abaco
 ```
 
 ## Features
+
 ## Usage
+
 ## Documentation
 Tutorials and documentation are available on [Read the Docs](https://mona-abaco.readthedocs.io/)
+
 ## Contributing
 1. Fork the repository
 2. Clone the repository
@@ -66,4 +71,5 @@ Tutorials and documentation are available on [Read the Docs](https://mona-abaco.
 5. Make changes
   > Note: we aimt o use numpy style python docstrings [sphinx example](https://www.sphinx-doc.org/en/master/usage/extensions/example_numpy.html#example-numpy)
 6. Make a pull request
+
 ## License

docs/conf.py

@@ -67,8 +67,8 @@
 # -- Options for HTML output -------------------------------------------------
 
 html_theme = "sphinx_book_theme"
-html_logo = "https://raw.githubusercontent.com/Multiomics-Analytics-Group/abaco/refs/heads/main/docs/figures/overview.png"
-html_favicon = "https://raw.githubusercontent.com/Multiomics-Analytics-Group/abaco/refs/heads/main/docs/figures/overview.png"
+html_logo = "https://raw.githubusercontent.com/Multiomics-Analytics-Group/abaco/HEAD/docs/images/logo/abaco_logo.svg"
+html_favicon = "https://raw.githubusercontent.com/Multiomics-Analytics-Group/abaco/HEAD/docs/images/logo/abaco_logo.svg"
 html_theme_options = {
     "github_url": "https://github.com/Multiomics-Analytics-Group/abaco",
     "repository_url": "https://github.com/Multiomics-Analytics-Group/abaco",