Total tree length

Sum of all branch lengths

Command identity

Canonical command:

total_tree_length

Handler:

total_tree_length

Aliases:

tree_len

Standalone executables:

pk_total_tree_length, pk_tree_len

Categories:

Tree summary statistics

Runtime interface

Synopsis

phykit total_tree_length <tree> [--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
--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 total tree length, which is a sum of all branches.

phykit total_tree_length <tree> [--json]

Options:
<tree>: first argument after function name should be a tree file
--json: optional argument to print results as JSON