Print tree
Print ASCII representation of a tree
Command identity
- Canonical command:
print_tree- Handler:
print_tree- Aliases:
print, pt
- Standalone executables:
pk_print_tree, pk_print, pk_pt
- Categories:
Tree manipulation & utilities
Runtime interface
Synopsis
phykit print_tree <tree> [--remove] [--json]
Arguments
This table is generated from the live command parser. It is the authoritative source for accepted spellings, required arguments, types, defaults, and choices.
Argument |
Required |
Type |
Default |
Choices |
|---|---|---|---|---|
|
true |
str |
required |
any |
|
false |
boolean |
false |
any |
|
false |
boolean |
false |
any |
Output and errors
--json provides the command's structured JSON representation. Unless the guidance below states otherwise, results are emitted as command output. Invalid command syntax exits with status 2. Input
validation and scientific limitations are described in the guidance below.
Guidance, interpretation, and examples
Print ascii tree of input phylogeny.
Phylogeny can be printed with or without branch lengths. By default, the phylogeny will be printed with branch lengths but branch lengths can be removed using the -r/--remove argument.
phykit print_tree <tree> [-r/--remove] [--json]
Options:
<tree>: first argument after function name should be a tree file
-r/--remove: optional argument to print the phylogeny without branch
lengths
--json: optional argument to print results as JSON