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
Input data
Alignment
--alignment - Value
FILE- Config key
alignment
Each --alignment file is numbered by its position in the list (1, 2, ...) and is one partition, unless --partition entries of ancestral, optimize, or timetree split it into several. A path that ends in .gz, .bz2, .xz, or .zst reads a compressed file. Use - to read uncompressed input from standard input (stdin); - may appear at most once.
Tree
--tree - Value
FILE- Config key
tree
A path that ends in .gz, .bz2, .xz, or .zst reads a compressed file.
- Value
NEWICK_DIALECT- Config key
newick_dialect- Values
classic,plainclassic,beastclassic,nhxclassic,mrbayesenewick,plainenewick,beastenewick,nhxenewick,mrbayesrich,plainrich,beastrich,nhxrich,mrbayes
A dialect is a tree structure and an annotation convention, written as <structure>,<annotations>. The structure is classic (plain labels and branch lengths), enewick (hybrid nodes such as x#H1) or rich (eNewick with support and probability fields). The annotations are plain (comments are text), beast ([&key=value]), nhx ([&&NHX:key=value]) or mrbayes ([&B name value]). For example, enewick,beast reads networks with BEAST annotations and classic,nhx reads NHX trees. TreeTime reads trees only, so a network input is an error.
- Config key
allow_missing_sequences
Without this flag the run aborts when more than one third of the tips lack a sequence, because the alignment may not belong to the tree. Useful for per-CDS translations, where some samples have no peptide for a given CDS.
- Value
ALPHABET- Config key
alphabet- Values
nucaaaa-no-stop
nuc (default): nucleotides A, C, G and T, with the IUPAC ambiguity codes and N for an unknown base. aa: the 20 amino acids and the stop codon * as a 21st state, with X for an unknown residue. aa-no-stop: the 20 amino acids without a state for the stop codon.
- Config key
zero_based
Applies to the mutations in the comments of Newick and Nexus trees and to the positions of the homoplasy report. Auspice JSON, augur node data, and UShER MAT outputs count from 1, as their formats require. An input table with positions, such as --drms, is always counted from 1.
Ancestral reconstruction
- Value
GAP_FILL- Config key
gap_fill- Values
only-terminalallnone
only-terminal (default, as in TreeTime 0.x): replace the leading and trailing gaps of each sequence with the unknown character of the alphabet (N or X). all: replace every gap with the unknown character. none: keep every gap.
Pruning
- Value
LEN- Config key
collapse_short
Removes each internal branch with a length below LEN and attaches the children of its node to the parent node.
- Config key
collapse_empty
Removes each internal branch that has no mutation or other state transition mapped to it.
Requires --alignment
- Config key
merge_shared_mutations
When sibling branches in a polytomy (node with >2 children) carry identical substitutions, they are grouped under a new internal node. The shared mutations move to the new branch (parent to new node), and only unique mutations remain on children's edges. Reduces tree builder artifacts from arbitrary binary resolution of polytomies.
Requires --alignment
- Value
NAME- Config key
remove
Accepts several names, separated by commas or spaces.
Remove file
--remove-file - Value
FILE- Config key
remove_file
Surrounding whitespace is trimmed and empty lines are ignored. A path that ends in .gz, .bz2, .xz, or .zst reads a compressed file. Use - to read uncompressed input from standard input (stdin).
Output
Output all
--output-all - Value
DIR- Config key
output_all
Writes the default outputs of the command as <dir>/<command>.<ext>. --output-selection restricts the outputs that the folder receives. The per-file flags (--output-*) override or supplement the files of the folder.
An output that the run has no data for is skipped without a message, for example the substitution model of a run that fits none. A per-file flag for such an output fails.
Every output path follows these rules. A path that ends in .gz, .bz2, .xz, or .zst writes a compressed file. The compression level is 2, unless the environment variable GZ_COMPRESSION, BZ2_COMPRESSION, XZ_COMPRESSION, or ZST_COMPRESSION sets another level. .gz, .xz, and .zst compress with all --jobs threads. .bz2 compresses with one thread and is much slower to write and to read than the other formats. The path - of a per-file flag writes the output uncompressed to standard output. Missing parent folders are created.
Table outputs choose the delimiter by the extension of their path: .tsv writes tabs and .csv commas, also before a compression suffix (dates.tsv.gz); - writes tabs to standard output. Default names use .tsv.
With several --alignment files, the outputs that carry sequence positions are written once per file: reconstructed sequences, the augur node data of ancestral, Auspice, UShER MAT, Nexus, and Newick with --newick-annotations other than plain. Files are numbered 1, 2, ... in the order of the --alignment list. Their default names carry the number after the command name (<dir>/<command>.1.<ext>), and the file name of a per-file flag for such an output must contain {alignment}, which is replaced by the number. Other tree outputs with {alignment} in their file name are also written once per file.
The outputs written once per CDS, such as the reconstructed amino-acid sequences, take the placeholder {cds} or %GENE in the file name of their per-file flag, which is replaced by the name of the CDS. The placeholder is required when more than one CDS is reconstructed; folder names are used as given.
- Value
NEWICK_ANNOTATIONS- Config key
newick_annotations- Values
plainbeastnhx
plain, beast, or nhx.plain writes no comments. beast writes a comment such as [&mutations="A45G,G136T",date=2016.45] after each node, and nhx writes the same values as [&&NHX:key=value]. The comments hold the mutations on the branch above the node, its date, and its inferred trait value, as far as the command infers them. Nexus outputs always carry beast comments, which FigTree reads.
Output tree Newick
--output-tree-nwk - Value
FILE- Config key
output_tree_nwk
--newick-annotations sets the node comments.
Output tree nexus
--output-tree-nexus - Value
FILE- Config key
output_tree_nexus
The nodes carry BEAST comments ([&mutations="A45G,G136T",date=2016.45]).
Output tree auspice
--output-tree-auspice - Value
FILE- Config key
output_tree_auspice
Output tree MAT protobuf
--output-tree-mat-pb - Value
FILE- Config key
output_tree_mat_pb
Output tree MAT JSON
--output-tree-mat-json - Value
FILE- Config key
output_tree_mat_json
Output tree graph JSON
--output-tree-graph-json - Value
FILE- Config key
output_tree_graph_json
Output tree DOT
--output-tree-dot - Value
FILE- Config key
output_tree_dot
- Value
OUTPUT_SELECTION- Config key
output_selection- Values
allnwknexusauspicemat-pbmat-jsongraph-jsondot
--output-all.Restricts which outputs --output-all writes. Special value all expands to every output available for this command. Requires --output-all. Per-file flags are always honored regardless of this selection.
A selected output that the run has no data for is skipped without a message, for example the substitution model of a run that fits none. A per-file flag for such an output fails. An output that the settings rule out fails in both forms, for example the sequences of timetree --branch-length-mode input.
Tree ordering
- Value
TOPOLOGY_ORDER- Config key
topology_order- Values
keepdescendant-countdescendant-count-reverseheightheight-reversedivergencedivergence-reverselabellabel-reversetarget-ordertarget-order-reverse
Topology order tree
--topology-order-tree - Value
FILE- Config key
topology_order_tree- Cannot be combined with
- --topology-order-list
Used by --topology-order target-order and target-order-reverse. Without this flag and --topology-order-list, the leaf order of the input tree is the target order. A path that ends in .gz, .bz2, .xz, or .zst reads a compressed file.
Topology order list
--topology-order-list - Value
FILE- Config key
topology_order_list- Cannot be combined with
- --topology-order-tree
Used by --topology-order target-order and target-order-reverse. Without this flag and --topology-order-tree, the leaf order of the input tree is the target order. A path that ends in .gz, .bz2, .xz, or .zst reads a compressed file.
- Value
TOPOLOGY_ORDER_AGGREGATE- Config key
topology_order_aggregate- Values
meanmedian