🌳 Documentation

Big Tree Python Package

Tree Implementation and Methods for Python, integrated with Python list, dictionary, and pandas DataFrame.

It is pythonic, making it easy to learn and extendable to many types of workflows.

---

Related Links:

• Documentation

• GitHub

• Community

  • Issues / Discussions / Changelog / Contributing

• Package

  • PyPI / Conda

• Articles

  • Python Tree Implementation with BigTree

  • The Reingold Tilford Algorithm Explained, with Walkthrough

• If you want to support bigtree,

---

Components

There are 3 segments to Big Tree consisting of Tree, Binary Tree, and Directed Acyclic Graph (DAG) implementation.

For Tree implementation, there are 9 main components.

1. 🌺 Node

   1. BaseNode, extendable class

   2. Node, BaseNode with node name attribute

2. ✨ Constructing Tree

   1. From Node, using parent and children constructors

   2. From str, using tree display or Newick string notation

   3. From list, using paths or parent-child tuples

   4. From nested dictionary, using path-attribute key-value pairs or recursive structure

   5. From pandas DataFrame, using paths or parent-child columns

   6. Add nodes to existing tree using path string

   7. Add nodes and attributes to existing tree using dictionary or pandas DataFrame, using path

   8. Add only attributes to existing tree using dictionary or pandas DataFrame, using node name

3. ➰ Traversing Tree

   1. Pre-Order Traversal

   2. Post-Order Traversal

   3. Level-Order Traversal

   4. Level-Order-Group Traversal

   5. ZigZag Traversal

   6. ZigZag-Group Traversal

4. 📝 Modifying Tree

   1. Copy nodes from location to destination

   2. Shift nodes from location to destination

   3. Shift and replace nodes from location to destination

   4. Copy nodes from one tree to another

   5. Copy and replace nodes from one tree to another

5. 🔍 Tree Search

   1. Find multiple nodes based on name, partial path, relative path, attribute value, user-defined condition

   2. Find single nodes based on name, partial path, relative path, full path, attribute value, user-defined condition

   3. Find multiple child nodes based on user-defined condition

   4. Find single child node based on name, user-defined condition

6. 🔧 Helper Function

   1. Cloning tree to another Node type

   2. Get subtree (smaller tree with different root)

   3. Prune tree (smaller tree with same root)

   4. Get difference between two trees

7. 📊 Plotting Tree

   1. Enhanced Reingold Tilford Algorithm to retrieve (x, y) coordinates for a tree structure

8. 🔨 Exporting Tree

   1. Print to console, in vertical or horizontal orientation

   2. Export to Newick string notation, dictionary, nested dictionary, or pandas DataFrame

   3. Export tree to dot (can save to .dot, .png, .svg, .jpeg files)

   4. Export tree to Pillow (can save to .png, .jpg)

   5. Export tree to Mermaid Flowchart (can display on .md)

9. ✔️ Workflows

   1. Sample workflows for tree demonstration!

---

For Binary Tree implementation, there are 3 main components. Binary Node inherits from Node, so the components in Tree implementation are also available in Binary Tree.

1. 🌿 Node

   1. BinaryNode, Node with binary tree rules

2. ✨ Constructing Binary Tree

   1. From list, using flattened list structure

3. ➰ Traversing Binary Tree

   1. In-Order Traversal

---

For Directed Acyclic Graph (DAG) implementation, there are 4 main components.

1. 🌼 Node

   1. DAGNode, extendable class for constructing Directed Acyclic Graph (DAG)

2. ✨ Constructing DAG

   1. From list, containing parent-child tuples

   2. From nested dictionary

   3. From pandas DataFrame

3. ➰ Traversing DAG

   1. Generic traversal method

4. 🔨 Exporting DAG

   1. Export to list, dictionary, or pandas DataFrame

   2. Export DAG to dot (can save to .dot, .png, .svg, .jpeg files)

---

Installation

There are two ways to install bigtree, with pip (from PyPI) or conda (from conda-forge).

a) Installation with pip (recommended)

To install bigtree, run the following line in command prompt:

$ pip install bigtree

If tree needs to use pandas methods, it requires additional dependencies. Run the following line in command prompt:

$ pip install 'bigtree[pandas]'

If tree needs to be exported to image, it requires additional dependencies. Run the following lines in command prompt:

$ pip install 'bigtree[image]'
$ brew install gprof2dot  # for MacOS
$ conda install graphviz  # for Windows

Alternatively, install all optional dependencies with the following line in command prompt:

$ pip install 'bigtree[all]'

b) Installation with conda

To install bigtree with conda, run the following line in command prompt:

$ conda install -c conda-forge bigtree