primeDLRS(1)

πŸ’– primeDLRS(1) πŸ’–

General Commands Manual energy, bestie. Buckle up, this one's a whole vibe ✨


🌸 NAME 🌸

primeDLRS, primeGSRf β€” the guest-in-host tree reconciliation tool πŸ¦‹

oh and btw, the old program name primeGSRf is still available β€” it's just a symlink to primeDLRS now, so if you type the old one, she'll answer πŸ’…


✨ SYNOPSIS ✨

primeDLRS [OPTIONS] seqfile hostfile [gsfile]

πŸ‘‘ DESCRIPTION πŸ‘‘

So this is the guest-in-host tree reconciliation tool, and she lets you analyse stuff like guest tree topologies, reconciliation properties, and duplication-loss rates. It's built on a Bayesian MCMC framework running the underlying GSR model. Periodt. πŸ‘‘

Here's what's actually being modelled, in order:

  1. the guest tree topology and its divergence times β€” modelled with a duplication-loss process in accordance with the Gene Evolution Model (GEM).
  2. sequence evolution β€” modelled with a user-defined substitution model.
  3. sequence evolution rate variation over guest tree edges (that's the relaxed molecular clock) β€” modelled with iid values from a user-selected distribution.
  4. sequence evolution rate variation over sites (positions) β€” modelled according to a discretized Gamma distribution.

The implementation does its computations using a discretization of the host tree. And like, please actually read the options before you run this, because you will need to change default settings. Also, option -r may be useful to avoid numeric issues due to scaling β€” just saying 🫢

seqfile is a file with aligned sequences for guest tree leaves.

hostfile is a PrIME Newick file with the host tree incl. divergence times. Heads up: leaves must have time 0 and root must have time > 0 ⏰

gsfile is a tab-delimited file relating guest tree leaves to host tree leaves, if that info isn't already included in hostfile.


πŸŽ€ OPTIONS πŸŽ€

okay real talk: a bunch of these defaults are literally blank in the original doc β€” like it just says Defaults to . with nothing there 😭 that's not me skipping anything, that's what it says, iykyk.
  • -h, -u, -? β€” Display help (this text). three whole ways to say "help me" πŸ’€
  • -o FILE β€” Output filename. Defaults to stderr.
  • -s UNSIGNED_INT β€” Seed for the pseudo-random number generator. Defaults to a random seed.
  • -i UNSIGNED_INT β€” Number of iterations. Defaults to .
  • -t UNSIGNED_INT β€” Thinning, i.e. sample every <value>-th iteration. Defaults to .
  • -w UNSIGNED_INT β€” Output diagnostics to stderr every <value>-th sample. Defaults to .
  • -q β€” Do not output diagnostics. Non-quiet by default. 🀫
  • -m MCMC|PDHC|PD β€” Execution type (MCMC, posterior density hill-climbing from initial values, or just initial posterior density). Defaults to .
  • -Sm UniformAA|JC69|F81|JTT|UniformCodon|ArveCodon β€” Substitution model. . by default.
  • -Su DNA|AminoAcid|Codon <Pi=float1 float2 ... floatn> <R=float1 float2 ...float(n*(n-1)/2)> β€” User-defined substitution model. The size of Pi and R must fit the data type (DNA: n=4, AminoAcid: n=20, Codon: n=62). R is given as a flattened upper triangular matrix. And don't use both option -Su and -Sm, bestie, pick a lane πŸ™ˆ
  • -Sn UNSIGNED_INT β€” Number of steps of discretized Gamma-distribution for sequence evolution rate variation over sites. Defaults to . (no variation).
  • -Ed Gamma|InvG|LogN|Uniform β€” Distribution for iid sequence evolution rate variation over guest tree edges. Defaults to . (and no, do not confuse this with -Sn 😭).
  • -Ep FLOAT FLOAT β€” Initial mean and variance of sequence evolution rate. Defaults to a simple rule-of-thumb based on host tree times.
  • -Ef β€” Fix mean and variance of sequence evolution rate. Non-fixed by default.
  • -Gi FILE β€” Filename with initial guest tree topology.
  • -Gg β€” Fix initial guest tree topology, i.e. perform no branch-swapping. Non-fixed by default.
  • -Gl β€” Fix initial guest tree edge lengths (in addition to topology), i.e. fix the edge lengths. Non-fixed by default.
  • -Bp FLOAT FLOAT β€” Initial duplication and loss rates. Defaults to . and .
  • -Bf β€” Fix initial duplication and loss rates. Non-fixed by default.
  • -Bt FLOAT β€” Override time span of edge above root in host tree. If the value is <=0, the span will be set to equal the root-to-leaf time. Defaults to the value in the host tree file. See also option -Dtt.
  • -Dt FLOAT β€” Approximate discretization timestep. Set to 0 to divide every edge in equally many parts (see -Di). Defaults to . See -Dtt for the edge above root.
  • -Di UNSIGNED_INT β€” Minimum number of parts to slice each edge in. If -Dt is set to 0, this becomes the exact number of parts. Minimum 2. Defaults to . See -Dtt for the edge above root.
  • -Dtt UNSIGNED_INT β€” Override number of discretization points for the edge above root in host tree. By default, irrespective of time span, this is set to the number of points for a (hypothetical) root-to-leaf edge
  • -r β€” Rescale the host tree so that the root-to-leaf time equals 1.0. All inferred parameters will refer to the new scale. Off by default. Note that discretization parameters are NOT rescaled. ⚠️
  • -Z β€” Do not print elapsed wall time and CPU time
  • -W β€” Do not print the command line
  • -debuginfo β€” Show misc. info to stderr before iterating. Not shown by default.

πŸ’€ EXIT STATUS πŸ’€

  • 0 β€” Successful program execution. ate πŸ’…
  • 1 β€” Some error occurred 😭

🌈 URL 🌈

The prime-phylo home page: http://prime.sbc.su.se


🫢 SEE ALSO 🫢

primeDTLSR(1), primeGEM(1), showtree(1), chainsaw(1), reconcile(1), reroot(1), tree2leafnames(1), treesize(1)


and that's the whole thing, bestie β€” this was prime-phylo version 1.0.11, dated 13 Mar, 2012 ✨ go reconcile some trees, you're gonna slay, mwah πŸ’–πŸŽ€