Skip to content

Commit 55a8331

Browse files
committed
update docu
1 parent b6fb750 commit 55a8331

File tree

1 file changed

+18
-22
lines changed

1 file changed

+18
-22
lines changed

README.md

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
11
# TreeProfiler Overview
22
TreeProfiler is a command line tool designed to automate the annotation of large phylogenetic trees with corresponding metadata. It also facilitates the visual exploration of these annotations as phylogenetic profiles, making it a powerful resource for researchers working with complex biological data.
33

4-
## Graphical Abstract
5-
<img src="https://github.com/dengzq1234/treeprofiler_gallery/blob/main/TreeProfiler_2025.png?raw=true" alt="TreeProfiler Abstract" width="640" height="360" />
4+
## Demo Animation
5+
![TreeProfiler Demo](https://github.com/dengzq1234/treeprofiler_gallery/blob/main/motus_habitat_full_render.gif?raw=true)
6+
7+
# Gallery of Interactive Examples
8+
Here is some examples figure from treeprofiler paper to demonstrate the scalbility and use case. For full code and figure reproduction instructions, please check at https://github.com/dengzq1234/treeprofiler_paper.
9+
10+
- [Figure 1A–E Layout Demos](https://treeprofiler_ex1.cgmlab.org/) and [Figure 1F–H Trait Types & Features](https://treeprofiler_ex2.cgmlab.org/). General overview.
11+
12+
![TreeProfiler general overview](https://github.com/dengzq1234/treeprofiler_paper/blob/main/fig1_general/fig1_general.png?raw=true)
13+
14+
- [Figure 2: POR_N Domain Family](https://treeprofiler_ex3.cgmlab.org/). Visualization of POR_N family phylogenetic tree across 13,297 sequences with taxonomic annotation, KEGG KO profiling and Pfam domain architectures.
15+
16+
![TreeProfiler emapper overview](https://github.com/dengzq1234/treeprofiler_paper/blob/main/fig2_POR_N/fig2_POR_N.png?raw=true)
17+
18+
- [Figure 3: mOTUs Abundance Profiles](https://treeprofiler_ex4.cgmlab.org/). Visualization of the mOTUs reference taxonomy tree with 124,295 leaves annotated with 51 habitat-specific abundance profiles.
19+
20+
![TreeProfiler motus overview](https://github.com/dengzq1234/treeprofiler_paper/blob/main/fig3_motus_full_habitat/fig3_motus_full_habitat.png?raw=true)
621

722
## Key Features:
823
- Automated Annotation that integrates metadata into phylogenetic tree, and summarizes annotation in internal nodes, including:
@@ -17,8 +32,6 @@ TreeProfiler is a command line tool designed to automate the annotation of large
1732
- Phylogenetic Signal Delta Statistic]
1833
- Lineage Specificity Analysis
1934

20-
## Demo Animation
21-
![TreeProfiler Demo](https://github.com/dengzq1234/treeprofiler_gallery/blob/main/motus_habitat_full_render.gif?raw=true)
2235

2336
## Documentation and Citation
2437
The official documentation of TreeProfiler is in https://dengzq1234.github.io/TreeProfiler/ where provides detailed instructions with examples.
@@ -38,20 +51,16 @@ bioRxiv (2023) doi: 10.1101/2023.09.21.558621
3851
# Table of Contents
3952

4053
- [TreeProfiler Overview](#treeprofiler-overview)
54+
- [Gallery of Interactive Examples](#gallery-of-interactive-examples)
4155
- [Installation](#installation)
4256
- [Quick Install via pip with Conda](#quick-install-via-pip-with-conda)
4357
- [Quick Start with Example Dataset](#quick-start-with-example-dataset)
4458
- [Install Latest TreeProfiler for Local Development](#install-latest-treeprofiler-for-local-development)
45-
4659
- [Basic Usage](#basic-usage)
4760
- [Input Files](#input-files)
4861
- [Using TreeProfiler via Command Line](#using-treeprofiler-via-command-line)
4962
- [Using TreeProfiler via GUI Interface](#using-treeprofiler-via-gui-interface)
50-
5163
- [Documentation](#documentation)
52-
53-
- [Gallery of Examples](#gallery-of-examples)
54-
5564
- [Getting Support and Issues](#getting-support-and-issues)
5665

5766
# Installation
@@ -216,19 +225,6 @@ We provided detailed step-by-step instructions covering most of the options with
216225

217226
https://dengzq1234.github.io/TreeProfiler/
218227

219-
# Gallery of examples
220-
Here is some examples figure from treeprofiler paper to demonstrate the scalbility and use case. For full code and figure reproduction instructions, please check at https://github.com/dengzq1234/treeprofiler_paper.
221-
222-
General overview (Online interactive session in [Figure 1A–E Layout Demos](http://138.4.139.25:5030/) and [Figure 1F–H Trait Types & Features](http://138.4.139.25:5031/))
223-
![TreeProfiler general overview](https://github.com/dengzq1234/treeprofiler_paper/blob/main/fig1_general/fig1_general.png?raw=true)
224-
225-
Visualization of POR_N family phylogenetic tree across 13,297 sequences with taxonomic annotation, KEGG KO profiling and Pfam domain architectures.
226-
(Online interactive session in [Figure 2: POR_N Domain Family](http://138.4.139.25:5032/))
227-
![TreeProfiler emapper overview](https://github.com/dengzq1234/treeprofiler_paper/blob/main/fig2_POR_N/fig2_POR_N.png?raw=true)
228-
229-
Visualization of the mOTUs reference taxonomy tree with 124,295 leaves annotated with 51 habitat-specific abundance profiles(Online interactive session in [Figure 3: mOTUs Abundance Profiles](http://138.4.139.25:5033/))
230-
![TreeProfiler motus overview](https://github.com/dengzq1234/treeprofiler_paper/blob/main/fig3_motus_full_habitat/fig3_motus_full_habitat.png?raw=true)
231-
232228
# Getting support and issues
233229
For bug reports, feature requests and general discussion, use
234230
https://github.com/compgenomicslab/TreeProfiler/issues

0 commit comments

Comments
 (0)