Skip to content

Commit 176b473

Browse files
committed
update docu
1 parent 55a8331 commit 176b473

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
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-
## Demo Animation
4+
# Key Features:
5+
- Automated Annotation that integrates metadata into phylogenetic tree, and summarizes annotation in internal nodes, including:
6+
- Categorical/Numerical metadata in TSV/CSV format
7+
- Taxonomic Annotation of NCBI/GTDB taxonomy database
8+
- Functional Annotation from eggnog-mapper output
9+
- Domain annotation from pfam/smart
10+
- Multiple Sequence Alignment annotation
11+
- Visual Exploration that allows for the detailed examination of annotated trees, aiding in the interpretation and presentation of data.
12+
- Analytic Methods for computing analysis from leaf nodes:
13+
- Ancestral Character Reconstruction for both discrete and continuous traits.
14+
- Phylogenetic Signal Delta Statistic]
15+
- Lineage Specificity Analysis
16+
17+
# Demo Animation
518
![TreeProfiler Demo](https://github.com/dengzq1234/treeprofiler_gallery/blob/main/motus_habitat_full_render.gif?raw=true)
619

720
# Gallery of Interactive Examples
@@ -19,21 +32,7 @@ Here is some examples figure from treeprofiler paper to demonstrate the scalbili
1932

2033
![TreeProfiler motus overview](https://github.com/dengzq1234/treeprofiler_paper/blob/main/fig3_motus_full_habitat/fig3_motus_full_habitat.png?raw=true)
2134

22-
## Key Features:
23-
- Automated Annotation that integrates metadata into phylogenetic tree, and summarizes annotation in internal nodes, including:
24-
- Categorical/Numerical metadata in TSV/CSV format
25-
- Taxonomic Annotation of NCBI/GTDB taxonomy database
26-
- Functional Annotation from eggnog-mapper output
27-
- Domain annotation from pfam/smart
28-
- Multiple Sequence Alignment annotation
29-
- Visual Exploration that allows for the detailed examination of annotated trees, aiding in the interpretation and presentation of data.
30-
- Analytic Methods for computing analysis from leaf nodes:
31-
- Ancestral Character Reconstruction for both discrete and continuous traits.
32-
- Phylogenetic Signal Delta Statistic]
33-
- Lineage Specificity Analysis
34-
35-
36-
## Documentation and Citation
35+
# Documentation and Citation
3736
The official documentation of TreeProfiler is in https://dengzq1234.github.io/TreeProfiler/ where provides detailed instructions with examples.
3837

3938
If you have any doubts, please drop a line in issue or contact https://x.com/deng_ziqi
@@ -43,15 +42,16 @@ Full manuscript of TreeProfiler is in https://doi.org/10.1101/2023.09.21.558621
4342
If you use TreeProfiler, please cite:
4443

4544
```
46-
Ziqi Deng, Ana Hernández-Plaza, Jaime Huerta-Cepas.
45+
Ziqi Deng, Ana Hernández-Plaza, Adrian Arellano Davin, Jaime Huerta-Cepas.
4746
"TreeProfiler: A command-line tool for computing and visualizing phylogenetic profiles against large trees"
4847
bioRxiv (2023) doi: 10.1101/2023.09.21.558621
4948
```
5049

5150
# Table of Contents
52-
5351
- [TreeProfiler Overview](#treeprofiler-overview)
52+
- [Key Features](#key-features)
5453
- [Gallery of Interactive Examples](#gallery-of-interactive-examples)
54+
- [Documentation and Citation](#documentation-and-citation)
5555
- [Installation](#installation)
5656
- [Quick Install via pip with Conda](#quick-install-via-pip-with-conda)
5757
- [Quick Start with Example Dataset](#quick-start-with-example-dataset)

0 commit comments

Comments
 (0)