Terminal branch statistics

Summary statistics of terminal branch lengths

Command identity

Canonical command:

terminal_branch_stats

Handler:

terminal_branch_stats

Aliases:

tbs

Standalone executables:

pk_terminal_branch_stats, pk_tbs

Categories:

Tree summary statistics

Runtime interface

Synopsis

phykit terminal_branch_stats <tree> [--verbose] [--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
tree	true	str	required	any
-v, --verbose	false	boolean	false	any
--json	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

Calculate summary statistics for terminal branch lengths in a phylogeny.

Terminal branch lengths can be useful for phylogeny diagnostics.

To obtain all terminal branch lengths, use the -v/--verbose option.

phykit terminal_branch_stats <tree> [-v/--verbose] [--json]

Options:
<tree>: first argument after function name should be a tree file
-v/--verbose: optional argument to print all terminal branch lengths
--json: optional argument to print results as JSON