Skip to content

Commit 9c60c5c

Browse files
committed
re order documentation
1 parent 176b473 commit 9c60c5c

1 file changed

Lines changed: 21 additions & 20 deletions

File tree

README.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
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+
# Table of Contents
5+
- [TreeProfiler Overview](#treeprofiler-overview)
6+
- [Key Features](#key-features)
7+
- [Gallery of Interactive Examples](#gallery-of-interactive-examples)
8+
- [Demo Animation](#demo-animation)
9+
- [Interactive Examples](#interactive-exampels)
10+
- [Documentation and Citation](#documentation-and-citation)
11+
- [Installation](#installation)
12+
- [Basic Usage](#basic-usage)
13+
- [Input Files](#input-files)
14+
- [Using TreeProfiler via Command Line](#using-treeprofiler-via-command-line)
15+
- [Using TreeProfiler via GUI Interface](#using-treeprofiler-via-gui-interface)
16+
- [Full Tutorial](#full-tutorial)
17+
- [Getting Support and Issues](#getting-support-and-issues)
18+
419
# Key Features:
520
- Automated Annotation that integrates metadata into phylogenetic tree, and summarizes annotation in internal nodes, including:
621
- Categorical/Numerical metadata in TSV/CSV format
@@ -11,15 +26,17 @@ TreeProfiler is a command line tool designed to automate the annotation of large
1126
- Visual Exploration that allows for the detailed examination of annotated trees, aiding in the interpretation and presentation of data.
1227
- Analytic Methods for computing analysis from leaf nodes:
1328
- Ancestral Character Reconstruction for both discrete and continuous traits.
14-
- Phylogenetic Signal Delta Statistic]
29+
- Phylogenetic Signal Delta Statistic
1530
- Lineage Specificity Analysis
1631

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

2033
# Gallery of Interactive Examples
2134
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.
2235

36+
## Demo Animation
37+
![TreeProfiler Demo](https://github.com/dengzq1234/treeprofiler_gallery/blob/main/motus_habitat_full_render.gif?raw=true)
38+
39+
## Interactive Examples
2340
- [Figure 1A–E Layout Demos](https://treeprofiler_ex1.cgmlab.org/) and [Figure 1F–H Trait Types & Features](https://treeprofiler_ex2.cgmlab.org/). General overview.
2441

2542
![TreeProfiler general overview](https://github.com/dengzq1234/treeprofiler_paper/blob/main/fig1_general/fig1_general.png?raw=true)
@@ -47,22 +64,6 @@ Ziqi Deng, Ana Hernández-Plaza, Adrian Arellano Davin, Jaime Huerta-Cepas.
4764
bioRxiv (2023) doi: 10.1101/2023.09.21.558621
4865
```
4966

50-
# Table of Contents
51-
- [TreeProfiler Overview](#treeprofiler-overview)
52-
- [Key Features](#key-features)
53-
- [Gallery of Interactive Examples](#gallery-of-interactive-examples)
54-
- [Documentation and Citation](#documentation-and-citation)
55-
- [Installation](#installation)
56-
- [Quick Install via pip with Conda](#quick-install-via-pip-with-conda)
57-
- [Quick Start with Example Dataset](#quick-start-with-example-dataset)
58-
- [Install Latest TreeProfiler for Local Development](#install-latest-treeprofiler-for-local-development)
59-
- [Basic Usage](#basic-usage)
60-
- [Input Files](#input-files)
61-
- [Using TreeProfiler via Command Line](#using-treeprofiler-via-command-line)
62-
- [Using TreeProfiler via GUI Interface](#using-treeprofiler-via-gui-interface)
63-
- [Documentation](#documentation)
64-
- [Getting Support and Issues](#getting-support-and-issues)
65-
6667
# Installation
6768
## Quick install via pip with conda
6869
```
@@ -220,7 +221,7 @@ Result visualization demo
220221
![TreeProfiler desktop result overview](https://raw.githubusercontent.com/dengzq1234/treeprofiler_gallery/refs/heads/main/treeprofiler_desktop_emapper.png)
221222

222223

223-
# Documentation
224+
# Full Tutorial
224225
We provided detailed step-by-step instructions covering most of the options with examples in the official documentation, and is available in:
225226

226227
https://dengzq1234.github.io/TreeProfiler/

0 commit comments

Comments
 (0)