Skip to content

Commit b50a4b2

Browse files
eprifticlaude
andcommitted
docs: Add ecosystem analysis section to Features and Usage
Document the new co-abundance ecosystem network visualization: Spearman correlations, Louvain community detection, taxonomic coloring, 4 layout algorithms, 3 color modes, and FBM overlay. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent a93211a commit b50a4b2

2 files changed

Lines changed: 15 additions & 1 deletion

File tree

docs/Features.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,19 @@ Build an ensemble of expert models from the best individuals across generations:
6565
- **Coefficient direction** -- Bar chart of model coefficients showing which features push toward which class
6666
- **Waterfall chart** -- Feature contribution decomposition for the best model
6767

68+
## Ecosystem Analysis
69+
70+
Visualize and explore microbial ecosystems as co-abundance networks, inspired by the Interpred approach (Cousin-Thorez, 2019) and the SCAPIS ecosystem work (Prifti, 2024).
71+
72+
- **Co-abundance network** -- Species correlation network built from the abundance matrix using pairwise Spearman correlations. Edges connect species with |rho| above a configurable threshold.
73+
- **Community detection** -- Louvain algorithm partitions the network into ecological modules (niches). Modularity score quantifies partition quality.
74+
- **Taxonomic coloring** -- Hierarchical color scheme: phylum base colors (SCAPIS palette) with family-level shading via lighten/darken gradients. Produces visually distinct colors for every family within each phylum.
75+
- **Multiple layout algorithms** -- Organic (Fruchterman-Reingold with simulated annealing), Force-directed, Circle, and Radial layouts.
76+
- **Three color modes** -- Taxonomy (phylum/family), Module (Louvain community), or Enrichment (which class each species is enriched in).
77+
- **FBM overlay** -- Annotate network nodes with data from the Family of Best Models: prevalence of each species across models and dominant coefficient direction (+1/-1). Bridges the ecological view with the predictive view.
78+
- **Interactive controls** -- Adjustable prevalence threshold, correlation threshold, class filtering (all/class 0/class 1), and module highlight on click.
79+
- **Node metrics** -- Degree, betweenness centrality, per-class prevalence, mean abundance.
80+
6881
## Web Application (PredomicsApp)
6982

7083
The web application provides a complete analysis workflow:
@@ -74,7 +87,7 @@ The web application provides a complete analysis workflow:
7487
- **Data exploration** -- Feature statistics, prevalence distribution, volcano plots, barcode visualization
7588
- **Parameter configuration** -- Template system, admin defaults, batch mode for sweeping parameters
7689
- **Real-time monitoring** -- Live console output with progress sparkline during job execution
77-
- **Interactive results** -- Plotly-based charts for all result views (summary, population, jury, comparative, co-presence)
90+
- **Interactive results** -- Plotly-based charts for all result views (summary, population, jury, comparative, co-presence, ecosystem)
7891
- **Export options** -- PDF biomarker reports, HTML reports, CSV tables, Python notebooks (.ipynb), R notebooks (.Rmd)
7992
- **Prediction API** -- Deploy trained models as REST endpoints for programmatic scoring
8093
- **User management** -- JWT authentication, API keys, role-based access (admin, viewer, editor)

docs/Usage.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ nav_order: 4
2222
- **Jury**: ensemble voting, confusion matrices, vote matrix, sample predictions
2323
- **Comparative**: compare multiple jobs side-by-side
2424
- **Co-presence**: feature co-occurrence analysis
25+
- **Ecosystem**: co-abundance network with taxonomic coloring and module detection
2526

2627
### Batch Mode
2728

0 commit comments

Comments
 (0)