You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-20Lines changed: 21 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,21 @@
1
1
# TreeProfiler Overview
2
2
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.
3
3
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
+
4
19
# Key Features:
5
20
- Automated Annotation that integrates metadata into phylogenetic tree, and summarizes annotation in internal nodes, including:
6
21
- Categorical/Numerical metadata in TSV/CSV format
@@ -11,15 +26,17 @@ TreeProfiler is a command line tool designed to automate the annotation of large
11
26
- Visual Exploration that allows for the detailed examination of annotated trees, aiding in the interpretation and presentation of data.
12
27
- Analytic Methods for computing analysis from leaf nodes:
13
28
- Ancestral Character Reconstruction for both discrete and continuous traits.
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.
-[Figure 1A–E Layout Demos](https://treeprofiler_ex1.cgmlab.org/) and [Figure 1F–H Trait Types & Features](https://treeprofiler_ex2.cgmlab.org/). General overview.
24
41
25
42

@@ -47,22 +64,6 @@ Ziqi Deng, Ana Hernández-Plaza, Adrian Arellano Davin, Jaime Huerta-Cepas.
47
64
bioRxiv (2023) doi: 10.1101/2023.09.21.558621
48
65
```
49
66
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
-
66
67
# Installation
67
68
## Quick install via pip with conda
68
69
```
@@ -220,7 +221,7 @@ Result visualization demo
220
221

221
222
222
223
223
-
# Documentation
224
+
# Full Tutorial
224
225
We provided detailed step-by-step instructions covering most of the options with examples in the official documentation, and is available in:
0 commit comments