treetime

optimize

Settings of treetime optimize (Optimize tree), with their flags, config keys, and defaults.

Diese Seite ist noch nicht übersetzt
Sie wird auf Englisch angezeigt. Einstellungstexte, Hilfetexte und die Befehlszeilenreferenz bleiben auf allen Seiten englisch.

Optimize branch lengths and local topology improvements.

Eingaben

  • Tree (erforderlich): Newick or Nexus
  • Alignment (erforderlich): Aligned FASTA
48 Einstellungen passen

Input data

Alignment

--alignment
Wert
FILE
Konfigurationsschlüssel
alignment
Aligned FASTA input

Partition

--partition Standard: keine
Wert
ENTRY
Konfigurationsschlüssel
partition
Nicht kombinierbar mit
--model --model-params --partition-by
Beispiele
  • [{"name":"cp12","sites":["1-1500\\3","2-1500\\3"]},{"name":"cp3","sites":["3-1500\\3"],"model":"hky85","model_params":["kappa=4"]}]
One partition: a set of sites of one --alignment file with its own substitution model; repeat the flag for each partition

Partition by

--partition-by Standard: nicht gesetzt
Wert
SCHEME
Konfigurationsschlüssel
partition_by
Werte
  • codon-positions Codon positions 1, 2 and 3 of every CDS of `--annotation` as the partitions `cp1`, `cp2` and `cp3`, and the other sites as `noncoding`
  • genes One partition per CDS of `--annotation`, named by the CDS, and the other sites as `noncoding`
  • rate-categories The partitions `slow`, `medium` and `fast` from the number of changes at each site in a Fitch reconstruction on the input tree, by the rule of `--rate-category-rule`
Nicht kombinierbar mit
--partition
Build the partitions of each --alignment file from a scheme instead of --partition entries

Rate category rule

--rate-category-rule Standard: change-counts
Wert
RULE
Konfigurationsschlüssel
rate_category_rule
Werte
  • change-counts `slow` for sites without changes, `medium` for one change, `fast` for two or more
  • median-split `slow` for sites without changes; changed sites at or below the median count of the changed sites go to `medium`, sites above it to `fast`
  • k-means The three groups of change counts with the smallest sum of squared deviations from their group means (exact one-dimensional k-means), named by increasing mean count
Rule that sorts the sites into the partitions of --partition-by rate-categories by their change counts

Annotation

--annotation
Wert
FILE
Konfigurationsschlüssel
annotation
Genome annotation (GFF3) with the coordinates of the CDSs of an --alignment file

Tree

--tree
Wert
FILE
Konfigurationsschlüssel
tree
Tree in Newick format

Segment trees

--segment-trees
Wert
FILE
Konfigurationsschlüssel
segment_trees
Trees of the genome segments, one Newick or Nexus file per segment, merged into one graph by node name

Segment alignments

--segment-alignments
Wert
FILE
Konfigurationsschlüssel
segment_alignments
Aligned FASTA input of the genome segments, one file per --segment-trees file, in the same order

Newick dialect

--newick-dialect Standard: classic,beast
Wert
NEWICK_DIALECT
Konfigurationsschlüssel
newick_dialect
Werte
  • 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 Standard: aus
Konfigurationsschlüssel
allow_missing_sequences
Treat tree tips that have no sequence in the alignment as fully ambiguous (missing data) instead of aborting.

Alphabet

--alphabet Standard: nicht gesetzt
Wert
ALPHABET
Konfigurationsschlüssel
alphabet
Werte
  • nuc
  • aa
  • aa-no-stop
Alphabet of the sequences

Zero based

--zero-based Standard: aus
Konfigurationsschlüssel
zero_based
Report sequence positions counted from 0 instead of 1.

Rooting

Reroot method

--reroot Standard: nicht gesetzt
Wert
REROOT
Konfigurationsschlüssel
reroot
Werte
  • min-dev Minimizes the variance of root-to-tip distances over all tips; more robust than midpoint
  • midpoint Roots at the middle of the longest tip-to-tip path; uses only the two farthest tips
Nicht kombinierbar mit
--keep-root --outgroup
Method that chooses the root of the tree from the branch lengths

Outgroup

--outgroup Standard: keine
Wert
OUTGROUP
Konfigurationsschlüssel
outgroup
Nicht kombinierbar mit
--keep-root --reroot
Beispiele
  • ["outgroup_tip"]
Root the tree on the branch above the most recent common ancestor of the named tips

Keep root

--keep-root Standard: aus
Konfigurationsschlüssel
keep_root
Nicht kombinierbar mit
--outgroup --reroot
Keep the root of the input tree instead of rerooting it.

Branch lengths

Iterations

--max-iter Standard: 10
Wert
N
Konfigurationsschlüssel
max_iter
Maximum number of iterations of the inference loop

Tolerance

--tolerance Standard: 0.1
Wert
TOLERANCE
Konfigurationsschlüssel
tolerance
Convergence threshold of the log-likelihood

Damping

--damping Standard: 0
Wert
DAMPING
Konfigurationsschlüssel
damping
Damping of the branch length updates of the loop, from 0 (inclusive) to 1 (exclusive)

Initial branch lengths

--initial-branch-lengths Standard: auto
Wert
INITIAL_BRANCH_LENGTHS
Konfigurationsschlüssel
initial_branch_lengths
Werte
  • auto Estimate only the branches with a missing or invalid length, and keep the valid input lengths
  • always Estimate every branch length, replacing the input lengths
  • never Keep the input branch lengths; the run fails when a branch has a missing or invalid length
Initial branch lengths before the optimization of each branch

Optimizer

--optimizer Standard: brent
Wert
OPTIMIZER
Konfigurationsschlüssel
optimizer
Werte
  • brent Brent's method on sqrt(t)
  • newton Newton-Raphson on sqrt(t)
Optimizer of each branch length; both methods optimize sqrt(t) in place of the branch length t

No collapse short branches

--no-collapse-short-branches Standard: aus
Konfigurationsschlüssel
no_collapse_short_branches
Disable collapsing of short internal branches.

No merge shared mutations

--no-merge-shared-mutations Standard: aus
Konfigurationsschlüssel
no_merge_shared_mutations
Disable merging of polytomy siblings that share substitutions.

No hoist reversions

--no-hoist-reversions Standard: aus
Konfigurationsschlüssel
no_hoist_reversions
Disable the reversion hoist in polytomies.

No indels

--no-indels Standard: aus
Konfigurationsschlüssel
no_indels
Disable indel (insertion and deletion) contributions to branch-length optimization and branch-length distributions.

Substitution model

Substitution model

--model Standard: infer
Wert
MODEL
Konfigurationsschlüssel
model
Werte
  • jc69
  • k80
  • f81
  • hky85
  • t92
  • tn93
  • jtt92
  • infer Infer GTR parameters from data via Fitch parsimony substitution counts.
Nicht kombinierbar mit
--partition
Substitution model to use

Model params

--model-params Standard: keine
Wert
MODEL_PARAMS
Konfigurationsschlüssel
model_params
Nicht kombinierbar mit
--partition
Parameters for the model selected by --model, given as space-separated key=value items

Partition rates

--partition-rates Standard: estimate
Wert
PARTITION_RATES
Konfigurationsschlüssel
partition_rates
Werte
  • estimate Estimate one relative rate per partition, normalized to a site-weighted mean of 1.
  • equal Fix the relative rate of every partition at 1.
Relative substitution rates of the partitions

Gamma categories

--gamma-categories Standard: nicht gesetzt
Wert
K
Konfigurationsschlüssel
gamma_categories
Number of discrete gamma rate categories of each partition (2 or more)

Shared params

--shared-params Standard: keine
Wert
SHARED_PARAMS
Konfigurationsschlüssel
shared_params
Werte
  • exchange-rates Share the exchange rates W.
  • frequencies Share the equilibrium frequencies pi.
  • gamma-shape Share the gamma shape alpha.
  • none Share no model parameter.
Model parameters that the partitions with an inferred model share, as a comma-separated list

Ancestral reconstruction

Representation

--representation Standard: auto
Wert
REPRESENTATION
Konfigurationsschlüssel
representation
Werte
  • auto Let TreeTime choose the representation; it chooses sparse
  • dense Probabilities of every state at every alignment position
  • sparse Only the variable positions
Representation of the sequences on the tree

Gap fill

--gap-fill Standard: only-terminal
Wert
GAP_FILL
Konfigurationsschlüssel
gap_fill
Werte
  • only-terminal
  • all
  • none
How to handle the gap characters of the input sequences

Output

Output all

--output-all
Wert
DIR
Konfigurationsschlüssel
output_all
Folder that receives the default outputs of the command

Newick annotations

--newick-annotations Standard: plain
Wert
NEWICK_ANNOTATIONS
Konfigurationsschlüssel
newick_annotations
Werte
  • plain
  • beast
  • nhx
Node comments of the Newick outputs: plain, beast, or nhx.

Output tree Newick

--output-tree-nwk
Wert
FILE
Konfigurationsschlüssel
output_tree_nwk
Path to output Newick tree file.

Output tree nexus

--output-tree-nexus
Wert
FILE
Konfigurationsschlüssel
output_tree_nexus
Path to output Nexus tree file.

Output tree auspice

--output-tree-auspice
Wert
FILE
Konfigurationsschlüssel
output_tree_auspice
Path to output Auspice v2 JSON tree file.

Output tree MAT protobuf

--output-tree-mat-pb
Wert
FILE
Konfigurationsschlüssel
output_tree_mat_pb
Path to output UShER MAT protobuf tree file.

Output tree MAT JSON

--output-tree-mat-json
Wert
FILE
Konfigurationsschlüssel
output_tree_mat_json
Path to output UShER MAT JSON tree file.

Output tree graph JSON

--output-tree-graph-json
Wert
FILE
Konfigurationsschlüssel
output_tree_graph_json
Path to output internal graph JSON tree file.

Output tree DOT

--output-tree-dot
Wert
FILE
Konfigurationsschlüssel
output_tree_dot
Path to output Graphviz DOT tree file.

Output files

--output-selection Standard: keine
Wert
OUTPUT_SELECTION
Konfigurationsschlüssel
output_selection
Werte
  • all
  • nwk
  • nexus
  • auspice
  • mat-pb
  • mat-json
  • graph-json
  • dot
  • node-data
  • model
List of outputs to produce with --output-all.

Divergence units

--divergence-units Standard: mutations-per-site
Wert
DIVERGENCE_UNITS
Konfigurationsschlüssel
divergence_units
Werte
  • mutations-per-site
  • mutations
Units of the divergence values in the augur node data and Auspice outputs.

Output node data

--output-node-data
Wert
FILE
Konfigurationsschlüssel
output_node_data
Path to output augur-compatible node data JSON.

Output model

--output-model
Wert
FILE
Konfigurationsschlüssel
output_model
Path to output the fitted substitution models as JSON.

Tree ordering

Topology order

--topology-order Standard: nicht gesetzt
Wert
TOPOLOGY_ORDER
Konfigurationsschlüssel
topology_order
Werte
  • 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
Wert
FILE
Konfigurationsschlüssel
topology_order_tree
Nicht kombinierbar mit
--topology-order-list
Tree whose leaf order sets the target order

Topology order list

--topology-order-list
Wert
FILE
Konfigurationsschlüssel
topology_order_list
Nicht kombinierbar mit
--topology-order-tree
File with leaf names in the target order, one name per line

Topology order aggregate

--topology-order-aggregate Standard: mean
Wert
TOPOLOGY_ORDER_AGGREGATE
Konfigurationsschlüssel
topology_order_aggregate
Werte
  • mean
  • median
Aggregate used to map a subtree to a target-order position.