treetime

clock

Settings of treetime clock (Clock signal), 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.

Infer the clock rate, assess the temporal signal and flag outliers using root-to-tip regression.

Eingaben

  • Tree (erforderlich): Newick or Nexus
  • Metadata (erforderlich): CSV, TSV or SSV table
33 Einstellungen passen

Input data

Tree

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

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)

Metadata

--metadata
Wert
FILE
Konfigurationsschlüssel
metadata
Metadata table (CSV or TSV) with one row per sample

Metadata id columns

--metadata-id-columns Standard: strain name accession
Wert
COLUMN
Konfigurationsschlüssel
metadata_id_columns
Candidate column name(s) holding the taxon identifier that links metadata to tree tips

Metadata delimiters

--metadata-delimiters Standard: , \t ;
Wert
CHAR
Konfigurationsschlüssel
metadata_delimiters
Candidate field delimiter(s) for the metadata table

Date column

--date-column Standard: nicht gesetzt
Wert
COLUMN
Konfigurationsschlüssel
date_column
Label of the column to be used as sampling date (auto-detected when omitted)

Date format

--date-format Standard: %Y-%m-%d
Wert
FORMAT
Konfigurationsschlüssel
date_format
Format used to parse string sampling dates (numeric, ISO, and uncertain dates parse regardless)

Molecular clock

Clock filter

--clock-filter Standard: 4
Wert
CLOCK_FILTER
Konfigurationsschlüssel
clock_filter
Ignore tips that do not follow a loose clock: the number of interquartile ranges from the root-to-tip regression beyond which a tip is an outlier.

Allow negative rate

--allow-negative-rate Standard: aus
Konfigurationsschlüssel
allow_negative_rate
Allow negative clock rates.

Prune filtered tips

--prune-filtered-tips Standard: aus
Konfigurationsschlüssel
prune_filtered_tips
Remove the tips that the clock filter flags from the tree.

Prune undated tips

--prune-undated-tips Standard: aus
Konfigurationsschlüssel
prune_undated_tips
Remove the tips without a usable date from the tree.

Keep tips

--keep-tips Standard: keine
Wert
NAME
Konfigurationsschlüssel
keep_tips
Names of tips that stay in the tree when --prune-filtered-tips or --prune-undated-tips removes tips

Keep tips file

--keep-tips-file
Wert
FILE
Konfigurationsschlüssel
keep_tips_file
File with names of tips that stay in the tree when --prune-filtered-tips or --prune-undated-tips removes tips, one name per line

Rooting

Reroot method

--reroot Standard: nicht gesetzt
Wert
REROOT
Konfigurationsschlüssel
reroot
Werte
  • least-squares Minimizes the residuals of the root-to-tip regression on the sampling dates
  • min-dev Minimizes the variance of root-to-tip distances over all tips; more robust than midpoint
  • oldest Roots at the middle of the branch above the oldest dated tip
  • 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

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.

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
  • clock-model
  • rtt
  • rtt-chart
List of outputs to produce with --output-all.

Output clock model

--output-clock-model
Wert
FILE
Konfigurationsschlüssel
output_clock_model
Path to output clock model JSON.

Output root-to-tip

--output-rtt
Wert
FILE
Konfigurationsschlüssel
output_rtt
Path to output the root-to-tip regression table.

Output root-to-tip chart

--output-rtt-chart
Wert
FILE
Konfigurationsschlüssel
output_rtt_chart
Path to output the root-to-tip regression chart.

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.