Merge pull request #154 from kayjan/v0.15.1

V0.15.1

Author: kayjan

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.15.1] - 2024-01-05
 ### Added
 - Tree Constructor: `newick_to_tree` to convert Newick notation to tree.
+- Tree Exporter: `hprint_tree` and `hyield_tree` to print and retrieve results for tree in horizontal orientation.
+- Node: Added `hshow` method to print tree in horizontal orientation to console.
 ### Changed
 - Tree Exporter: `tree_to_newick` to accept more parameters to parse length and attributes.
 ### Fixed

README.md

@@ -66,7 +66,7 @@ For **Tree** implementation, there are 9 main components.
 7. [**📊 Plotting Tree**](https://bigtree.readthedocs.io/en/latest/bigtree/utils/plot.html)
    1. Enhanced Reingold Tilford Algorithm to retrieve (x, y) coordinates for a tree structure
 8. [**🔨 Exporting Tree**](https://bigtree.readthedocs.io/en/latest/bigtree/tree/export.html)
-   1. Print to console
+   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)
@@ -182,6 +182,11 @@ root.show()
 # │   └── d
 # └── c
 
+root.hshow()
+#      ┌─ b ─── d
+# ─ a ─┤
+#      └─ c
+
 graph = tree_to_dot(root, node_colour="gold")
 graph.write_png("assets/docs/demo_tree.png")
 ```
@@ -389,12 +394,13 @@ root.show(attr_list=["age"])
 
 ### Print Tree
 
-After tree is constructed, it can be viewed by printing to console using `show` method directly.
-Alternatively, the `print_tree` method can be used.
+After tree is constructed, it can be viewed by printing to console using `show` or `hshow` method directly,
+for vertical and horizontal orientation respectively.
+Alternatively, the `print_tree` or `hprint_tree` method can be used.
 
-{emphasize-lines="8,16,21,27,34,41,49,56,63,70,77,84,91-95"}
+{emphasize-lines="8,15,22,27,33,40,47,55,62,69,76,83,90,97-101"}
 ```python
-from bigtree import Node, print_tree
+from bigtree import Node, print_tree, hprint_tree
 
 root = Node("a", age=90, gender="F")
 b = Node("b", age=65, gender="M", parent=root)
@@ -408,6 +414,12 @@ print_tree(root)
 # │   └── e
 # └── c
 
+hprint_tree(root)
+#            ┌─ d
+#      ┌─ b ─┤
+# ─ a ─┤     └─ e
+#      └─ c
+
 # Print subtree
 print_tree(root, node_name_or_path="b")
 # b
@@ -531,6 +543,7 @@ Below are the tables of attributes available to `BaseNode` and `Node` classes.
 | Check if leaf node                   | `root.is_leaf`     | False                      |
 | Check depth of node                  | `node_b.depth`     | 2                          |
 | Check depth of tree                  | `node_b.max_depth` | 4                          |
+| Get root of tree                     | `node_b.root`      | Node(/a, )                 |
 | Get node path                        | `node_b.node_path` | (Node(/a, ), Node(/a/b, )) |
 | Get node name (only for `Node`)      | `node_b.node_name` | 'b'                        |
 | Get node path name (only for `Node`) | `node_b.path_name` | '/a/b'                     |
@@ -548,14 +561,18 @@ Below are the tables of attributes available to `BaseNode` and `Node` classes.
 
 Below is the table of operations available to `BaseNode` and `Node` classes.
 
-| Operations                         | Code                                                       | Returns                                    |
-|------------------------------------|------------------------------------------------------------|--------------------------------------------|
-| Get node information               | `root.describe(exclude_prefix="_")`                        | [('name', 'a')]                            |
-| Find path from one node to another | `root.go_to(node_e)`                                       | [Node(/a, ), Node(/a/b, ), Node(/a/b/e, )] |
-| Set attribute(s)                   | `root.set_attrs({"description": "root-tag"})`              | None                                       |
-| Get attribute                      | `root.get_attr("description")`                             | 'root-tag'                                 |
-| Copy tree                          | `root.copy()`                                              | None                                       |
-| Sort children                      | `root.sort(key=lambda node: node.node_name, reverse=True)` | None                                       |
+| Operations                                      | Code                                                       | Returns                                    |
+|-------------------------------------------------|------------------------------------------------------------|--------------------------------------------|
+| Visualize tree (only for `Node`)                | `root.show()`                                              | None                                       |
+| Visualize tree (horizontally) (only for `Node`) | `root.hshow()`                                             | None                                       |
+| Get node information                            | `root.describe(exclude_prefix="_")`                        | [('name', 'a')]                            |
+| Find path from one node to another              | `root.go_to(node_e)`                                       | [Node(/a, ), Node(/a/b, ), Node(/a/b/e, )] |
+| Add child to node                               | `root.append(Node("j"))`                                   | None                                       |
+| Add multiple children to node                   | `root.extend([Node("k"), Node("l")])`                      | None                                       |
+| Set attribute(s)                                | `root.set_attrs({"description": "root-tag"})`              | None                                       |
+| Get attribute                                   | `root.get_attr("description")`                             | 'root-tag'                                 |
+| Copy tree                                       | `root.copy()`                                              | None                                       |
+| Sort children                                   | `root.sort(key=lambda node: node.node_name, reverse=True)` | None                                       |
 
 ### Traverse Tree
 

bigtree/__init__.py

@@ -23,6 +23,8 @@
     str_to_tree,
 )
 from bigtree.tree.export import (
+    hprint_tree,
+    hyield_tree,
     print_tree,
     tree_to_dataframe,
     tree_to_dict,

bigtree/tree/export.py

@@ -494,8 +494,8 @@ def hyield_tree(
     >>> c = Node("c", parent=root)
     >>> d = Node("d", parent=b)
     >>> e = Node("e", parent=b)
-    >>> tree_str = hyield_tree
-    >>> print("\n".join(tree_str))
+    >>> result = hyield_tree(root)
+    >>> print("\\n".join(result))
                ┌─ d
          ┌─ b ─┤
     ─ a ─┤     └─ e

docs/source/_static/custom.css

@@ -21,6 +21,9 @@ header {
 h1, h2, h3, h4, p, a {
     font-family: Nobile, sans-serif !important;
 }
+pre {
+    font-family: monospace;
+}
 p {
     margin-bottom: 2rem;
 }