treetime

prune

Settings of treetime prune (Prune tree), with their flags, config keys, and defaults.

Collapse short branches and remove listed samples.

Inputs

  • Tree (required): Newick or Nexus
  • Alignment (optional): Aligned FASTA
26 settings match

Input data

Alignment

--alignment
Value
FILE
Config key
alignment
Aligned FASTA input

Tree

--tree
Value
FILE
Config key
tree
Tree in Newick format

Newick dialect

--newick-dialect Default: classic,beast
Value
NEWICK_DIALECT
Config key
newick_dialect
Values
  • classic,plain
  • classic,beast
  • classic,nhx
  • classic,mrbayes
  • enewick,plain
  • enewick,beast
  • enewick,nhx
  • enewick,mrbayes
  • rich,plain
  • rich,beast
  • rich,nhx
  • rich,mrbayes
Newick dialect of the tree inputs (the tree and the reference topology)

Allow missing sequences

--allow-missing-sequences Default: off
Config key
allow_missing_sequences
Treat tree tips that have no sequence in the alignment as fully ambiguous (missing data) instead of aborting.

Alphabet

--alphabet Default: not set
Value
ALPHABET
Config key
alphabet
Values
  • nuc
  • aa
  • aa-no-stop
Alphabet of the sequences

Zero based

--zero-based Default: off
Config key
zero_based
Report sequence positions counted from 0 instead of 1.

Ancestral reconstruction

Gap fill

--gap-fill Default: only-terminal
Value
GAP_FILL
Config key
gap_fill
Values
  • only-terminal
  • all
  • none
How to handle the gap characters of the input sequences

Pruning

Collapse short

--collapse-short Default: not set
Value
LEN
Config key
collapse_short
Collapse branches shorter than this length

Collapse empty

--collapse-empty Default: off
Config key
collapse_empty
Collapse branches without mutations

Merge shared mutations

--merge-shared-mutations Default: off
Config key
merge_shared_mutations
Merge branches in polytomies that share identical mutations

Remove

--remove Default: none
Value
NAME
Config key
remove
Names of nodes to remove from the tree

Remove file

--remove-file
Value
FILE
Config key
remove_file
File with names of nodes to remove from the tree, one name per line

Output

Output all

--output-all
Value
DIR
Config key
output_all
Folder that receives the default outputs of the command

Newick annotations

--newick-annotations Default: plain
Value
NEWICK_ANNOTATIONS
Config key
newick_annotations
Values
  • plain
  • beast
  • nhx
Node comments of the Newick outputs: plain, beast, or nhx.

Output tree Newick

--output-tree-nwk
Value
FILE
Config key
output_tree_nwk
Path to output Newick tree file.

Output tree nexus

--output-tree-nexus
Value
FILE
Config key
output_tree_nexus
Path to output Nexus tree file.

Output tree auspice

--output-tree-auspice
Value
FILE
Config key
output_tree_auspice
Path to output Auspice v2 JSON tree file.

Output tree MAT protobuf

--output-tree-mat-pb
Value
FILE
Config key
output_tree_mat_pb
Path to output UShER MAT protobuf tree file.

Output tree MAT JSON

--output-tree-mat-json
Value
FILE
Config key
output_tree_mat_json
Path to output UShER MAT JSON tree file.

Output tree graph JSON

--output-tree-graph-json
Value
FILE
Config key
output_tree_graph_json
Path to output internal graph JSON tree file.

Output tree DOT

--output-tree-dot
Value
FILE
Config key
output_tree_dot
Path to output Graphviz DOT tree file.

Output files

--output-selection Default: none
Value
OUTPUT_SELECTION
Config key
output_selection
Values
  • all
  • nwk
  • nexus
  • auspice
  • mat-pb
  • mat-json
  • graph-json
  • dot
List of outputs to produce with --output-all.

Tree ordering

Topology order

--topology-order Default: not set
Value
TOPOLOGY_ORDER
Config key
topology_order
Values
  • keep
  • descendant-count
  • descendant-count-reverse
  • height
  • height-reverse
  • divergence
  • divergence-reverse
  • label
  • label-reverse
  • target-order
  • target-order-reverse
Canonical topology ordering preset.

Topology order tree

--topology-order-tree
Value
FILE
Config key
topology_order_tree
Cannot be combined with
--topology-order-list
Tree whose leaf order sets the target order

Topology order list

--topology-order-list
Value
FILE
Config key
topology_order_list
Cannot be combined with
--topology-order-tree
File with leaf names in the target order, one name per line

Topology order aggregate

--topology-order-aggregate Default: mean
Value
TOPOLOGY_ORDER_AGGREGATE
Config key
topology_order_aggregate
Values
  • mean
  • median
Aggregate used to map a subtree to a target-order position.