treetime

timetree

Settings of treetime timetree (Time 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.

Infer a time tree and estimate the clock rate from sampling dates.

Eingaben

  • Tree (erforderlich): Newick or Nexus
  • Metadata (erforderlich): CSV, TSV or SSV table
  • Alignment (empfohlen): Aligned FASTA
81 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.

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)

Sequence length

--sequence-length Standard: nicht gesetzt
Wert
N
Konfigurationsschlüssel
sequence_length
Length of the sequences, used to calculate the expected variation of the branch lengths

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.

Molecular clock

Clock rate

--clock-rate Standard: nicht gesetzt
Wert
CLOCK_RATE
Konfigurationsschlüssel
clock_rate
Beispiele
  • 0.001
Fixed rate of the molecular clock, in substitutions per site per year

Clock rate std. dev.

--clock-std-dev Standard: nicht gesetzt
Wert
CLOCK_STD_DEV
Konfigurationsschlüssel
clock_std_dev
Standard deviation of the provided clock rate estimate

Relaxed clock (slack, coupling)

--relax Standard: keine
Wert
SLACK COUPLING
Konfigurationsschlüssel
relax
Beispiele
  • [1,0]
Use an autocorrelated relaxed clock with the given prior strengths, for example --relax 1.0 0.5

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.

Branch lengths

Branch length mode

--branch-length-mode Standard: auto
Wert
BRANCH_LENGTH_MODE
Konfigurationsschlüssel
branch_length_mode
Werte
  • auto `input` without an alignment or when the longest input branch is longer than 0.1 substitutions per site, `marginal` otherwise
  • input Keep the branch lengths of the input tree
  • marginal Estimate the branch lengths from the alignment by marginal ancestral reconstruction
How the branch lengths of the time inference are obtained

Iterations

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

No collapse short branches

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

No indels

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

Dating

Confidence

--confidence Standard: aus
Konfigurationsschlüssel
confidence
Estimate the 90% intervals of the node dates

Max grid points

--max-grid-points Standard: nicht gesetzt
Wert
N
Konfigurationsschlüssel
max_grid_points
Beispiele
  • 1000000
Largest number of points of one probability grid during time inference

Cross parent messages

--cross-parent-messages Standard: aus
Konfigurationsschlüssel
cross_parent_messages
On a graph of segment trees, include the messages from the other parents in the message to a parent

Polytomies

Keep polytomies

--keep-polytomies Standard: aus
Konfigurationsschlüssel
keep_polytomies
Keep the polytomies of the input tree

Coalescent prior

Coalescent prior

--coalescent Standard: nicht gesetzt
Wert
TC|opt|skyline
Konfigurationsschlüssel
coalescent
Werte
  • opt
  • skyline
Beispiele
  • 0.01
Coalescent prior: a fixed time scale in substitutions per site (as in TreeTime 0.x and augur, for example 0.01) or as a time (10y, 26w, 90d); opt fits a constant time scale; skyline fits a piecewise-constant one

Skyline grid points

--n-skyline Standard: 20
Wert
N
Konfigurationsschlüssel
n_skyline
Number of grid points of the skyline coalescent model

Skyline stiffness

--skyline-stiffness Standard: 2
Wert
SKYLINE_STIFFNESS
Konfigurationsschlüssel
skyline_stiffness
Smoothing stiffness of the skyline coalescent model

Coalescent confidence

--coalescent-confidence Standard: 2
Wert
COALESCENT_CONFIDENCE
Konfigurationsschlüssel
coalescent_confidence
Width of the bands of the coalescent time scale Tc, in standard deviations

Gen per year

--gen-per-year Standard: 50
Wert
GEN_PER_YEAR
Konfigurationsschlüssel
gen_per_year
Generations per year, to convert the coalescent time scale Tc into an effective population size

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

Include leaves

--include-leaves Standard: aus
Konfigurationsschlüssel
include_leaves
Emit reconstructed leaf (tip) sequences in addition to internal nodes.

Reconstruct tip states

--reconstruct-tip-states Standard: aus
Konfigurationsschlüssel
reconstruct_tip_states
Same as --include-leaves --impute-missing-data: emit tip sequences with ambiguous and unknown states resolved to the most likely inferred state.

Report ambiguous

--report-ambiguous Standard: aus
Konfigurationsschlüssel
report_ambiguous
Include branch mutations from or to the fully ambiguous state (N for nucleotides, X for amino acids).

Impute missing data

--impute-missing-data Standard: aus
Konfigurationsschlüssel
impute_missing_data
Resolve ambiguous and unknown tip states (N and IUPAC codes such as R) to the most likely inferred state.

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
  • sequences
  • clock-model
  • rtt
  • dates
  • tracelog
  • coalescent
  • coalescent-json
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.

Output sequences

--output-sequences
Wert
FILE
Konfigurationsschlüssel
output_sequences
Path to output the nucleotide sequences of the nodes as FASTA.

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 dates

--output-dates
Wert
FILE
Konfigurationsschlüssel
output_dates
Path to output node dates TSV: calendar date and numeric date of every node, with the bounds of the 90% max posterior region with --confidence.

Output tracelog

--output-tracelog
Wert
FILE
Konfigurationsschlüssel
output_tracelog
Path to output the convergence values of every iteration as a table

Output coalescent

--output-coalescent
Wert
FILE
Konfigurationsschlüssel
output_coalescent
Path to output the coalescent time scale as a table (one row per skyline segment).

Output coalescent JSON

--output-coalescent-json
Wert
FILE
Konfigurationsschlüssel
output_coalescent_json
Path to output the coalescent time scale as a rich JSON document (inputs + segments).

Ambiguity threshold

--ambiguity-threshold Standard: nicht gesetzt
Wert
AMBIGUITY_THRESHOLD
Konfigurationsschlüssel
ambiguity_threshold
Report every state whose posterior probability is at most this far below the probability of the most likely state.

Ambiguity outputs

--ambiguity-outputs Standard: keine
Wert
AMBIGUITY_OUTPUTS
Konfigurationsschlüssel
ambiguity_outputs
Werte
  • sequences Reconstructed nucleotide FASTA
List of the outputs that carry the ambiguity report.

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.

Reproducibility

Seed

--seed Standard: nicht gesetzt
Wert
SEED
Konfigurationsschlüssel
seed
Random seed