From 011418e414269067588847d33d640fdcc9f2ae1a Mon Sep 17 00:00:00 2001 From: Kay Jan WONG Date: Wed, 22 Mar 2023 14:25:31 +0800 Subject: [PATCH] update README with links --- README.md | 39 +++++++++++++++++++++------------------ 1 file changed, 21 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 9d11489b..e020b236 100644 --- a/README.md +++ b/README.md @@ -22,68 +22,71 @@ Related Links: ## Components There are 3 segments to Big Tree consisting of Tree, Binary Tree, and Directed Acyclic Graph (DAG) implementation. -For Tree implementation, there are 8 main components. -1. **Node** +For **Tree** implementation, there are 8 main components. + +1. [**Node**](https://bigtree.readthedocs.io/en/latest/node.html) 1. ``BaseNode``, extendable class 2. ``Node``, BaseNode with node name attribute -2. **Constructing Tree** +2. [**Constructing Tree**](https://bigtree.readthedocs.io/en/latest/bigtree/tree/construct.html) 1. From *list*, using paths or parent-child tuples 2. From *nested dictionary*, using path or recursive structure 3. From *pandas DataFrame*, using paths or parent-child columns 4. Add nodes to existing tree using string 5. Add nodes and attributes to existing tree using dictionary or pandas DataFrame, using path 6. Add only attributes to existing tree using dictionary or pandas DataFrame, using node name -3. **Traversing Tree** +3. [**Traversing Tree**](https://bigtree.readthedocs.io/en/latest/bigtree/utils/iterators.html) 1. Pre-Order Traversal 2. Post-Order Traversal 3. Level-Order Traversal 4. Level-Order-Group Traversal -4. **Modifying Tree** +4. [**Modifying Tree**](https://bigtree.readthedocs.io/en/latest/bigtree/tree/modify.html) 1. Shift nodes from location to destination 2. Copy nodes from location to destination 3. Copy nodes from one tree to another -5. **Tree Search** +5. [**Tree Search**](https://bigtree.readthedocs.io/en/latest/bigtree/tree/search.html) 1. Find multiple nodes based on name, partial path, attribute value, user-defined condition 2. Find single nodes based on name, partial 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** +6. [**Helper Function**](https://bigtree.readthedocs.io/en/latest/bigtree/tree/helper.html) 1. Cloning tree to another `Node` type 2. Prune tree 3. Get difference between two trees -7. **Exporting Tree** +7. [**Exporting Tree**](https://bigtree.readthedocs.io/en/latest/bigtree/tree/export.html) 1. Print to console 2. Export to *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) -8. **Workflows** +8. [**Workflows**](https://bigtree.readthedocs.io/en/latest/workflows.html) 1. Sample workflows for tree demonstration! -For Binary Tree implementation, there are 3 main components. +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. [**Node**](https://bigtree.readthedocs.io/en/latest/node.html) 1. ``BinaryNode``, Node with binary tree rules -2. **Constructing Binary Tree** +2. [**Constructing Binary Tree**](https://bigtree.readthedocs.io/en/latest/bigtree/binarytree/construct.html) 1. From *list*, using flattened list structure -3. **Traversing Binary Tree** +3. [**Traversing Binary Tree**](https://bigtree.readthedocs.io/en/latest/bigtree/utils/iterators.html) 1. In-Order Traversal -For Directed Acyclic Graph (DAG) implementation, there are 4 main components. +For **Directed Acyclic Graph (DAG)** implementation, there are 4 main components. -1. **Node** +1. [**Node**](https://bigtree.readthedocs.io/en/latest/node.html) 1. ``DAGNode``, extendable class for constructing Directed Acyclic Graph (DAG) -2. **Constructing DAG** +2. [**Constructing DAG**](https://bigtree.readthedocs.io/en/latest/bigtree/dag/construct.html) 1. From *list*, containing parent-child tuples 2. From *nested dictionary* 3. From *pandas DataFrame* -3. **Traversing DAG** +3. [**Traversing DAG**](https://bigtree.readthedocs.io/en/latest/bigtree/utils/iterators.html) 1. Generic traversal method -4. **Exporting DAG** +4. [**Exporting DAG**](https://bigtree.readthedocs.io/en/latest/bigtree/dag/export.html) 1. Export to *list*, *dictionary*, or *pandas DataFrame* 2. Export DAG to dot (can save to .dot, .png, .svg, .jpeg files) +---- + ## Installation To install `bigtree`, run the following line in command prompt: