Branch length multiplier

Multiply branch lengths by a factor

Command identity

Canonical command:

branch_length_multiplier

Handler:

branch_length_multiplier

Aliases:

blm

Standalone executables:

pk_branch_length_multiplier, pk_blm

Categories:

Tree manipulation & utilities

Runtime interface

Synopsis

phykit branch_length_multiplier <tree> --factor <factor> [--output <output>] [--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
-f, --factor	true	float	required	any
-o, --output	false	str	none	any
--json	false	boolean	false	any

Output and errors

--json provides the command's structured JSON representation. Output-file options: --output. Invalid command syntax exits with status 2. Input validation and scientific limitations are described in the guidance below.

Guidance, interpretation, and examples

Multiply branch lengths in a phylogeny by a given factor.

This can help modify reference trees when conducting simulations or other analyses.

phykit branch_length_multiplier <tree> -f n [-o/--output <output_file>] [--json]

Options:
<tree>: first argument after function name should be a tree file
-f/--factor: factor to multiply branch lengths by
-o/--output: optional argument to name the outputted tree file. Default output will have the same name as the input file but with the suffix ".factor_(n).tre"
--json: optional argument to print results as JSON