Tip-to-tip node distance

Node distance between two tips

Command identity

Canonical command:

tip_to_tip_node_distance

Handler:

tip_to_tip_node_distance

Aliases:

t2t_nd, t2t_node_dist

Standalone executables:

pk_tip_to_tip_node_distance, pk_t2t_nd, pk_t2t_node_dist

Categories:

Tree summary statistics

Runtime interface

Synopsis

phykit tip_to_tip_node_distance <tree_zero> <tip_1> <tip_2> [--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_zero	true	str	required	any
tip_1	true	str	required	any
tip_2	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 distance between two tips (or leaves) in a phylogeny.

Distance is measured by the number of nodes between one tip and another.

phykit tip_to_tip_node_distance <tree_file> <tip_1> <tip_2> [--json]

Options:
<tree_file>: first argument after function name should be a tree file
<tip_1>: second argument should be the name of the first tip of interest
<tip_2>: third argument should be the name of the second tip of interest
--json: optional argument to print results as JSON