chainsaw(1)

πŸ’– chainsaw(1) β€” cut a gene tree based on a reconciliation πŸ’–

okay bestie, welcome to the General Commands Manual, section 1, where we talk about chainsaw πŸͺšβœ¨. yes it's literally called chainsaw. no it does not cut wood. it cuts trees (the phylogenetic kind, bestie, keep up πŸ’…).


🌸 NAME 🌸

chainsaw β€” cut a gene tree based on a reconciliation. that's it. that's the whole vibe. πŸŽ€


✨ SYNOPSIS ✨

chainsaw [OPTIONS] reconciled-gene-tree  species-tree

two positional arguments, and they are not optional, so like… give her what she wants 🫢


πŸ¦‹ DESCRIPTION πŸ¦‹

reconciled-gene-tree is the filename of the file containing trees in PRIME format. and here's the lil tea: the node id is optional β˜• β€” if you leave it out, all species nodes will be used recursively. so it's giving "do the whole thing, queen" πŸ‘‘

species-tree is the species tree. yes that's really all it says. she's a tree. the species one. 🌳


πŸ’… OPTIONS πŸ’…

  • --help β€” Display help (this text). the classic. the icon. she shows you the manual you are currently reading πŸ“–
  • -V, --version β€” Print version and exit. one and done, no notes πŸ’«
  • -g, --guest-tree-format primeOrHybrid|inputxml β€” The input format. Default is primeOrHybrid. note that she said guest tree β€” that's the gene tree, bestie, don't @ me πŸ™ˆ
  • -h, --host-tree-format primeOrHybrid|inputxml β€” The input format of the host tree. Default is primeOrHybrid. ⚠️ lowkey important: -h here is host-tree-format, NOT help. the help flag is --help with no short form. do not get got by this. i'm serious. 😭
  • -x, --node-name=STRING β€” A named species node to cut at. you give her a name, she cuts there βœ‚οΈ
  • -i, --node-id=INT β€” The numerical id of a species node to cut at. same energy, but with numbers instead of names πŸ”’

🚦 EXIT STATUS 🚦

  1. 0 β€” Successful program execution. we ate and left no crumbs 🍽️✨
  2. 1 β€” Some error occurred. it's giving πŸ’€ but it's fine, we move

🌈 URL 🌈

The prime-phylo home page: http://prime.sbc.su.se β€” go say hi, she's lovely 🫢


πŸ‘€ SEE ALSO πŸ‘€

primeDTLSR(1), primeDLRS(1), primeGEM(1), showtree(1), reconcile(1), reroot(1), tree2leafnames(1), treesize(1) β€” the whole friend group, go follow them, iykyk πŸ’œ


bestie reminder: -h is host-tree-format. not help. i will not be repeating myself (i will be repeating myself). πŸŽ€

and that's the page!! this one came from prime-phylo 1.0.11, dated 13 Mar, 2012 β€” vintage, iconic, still slaying. mwah πŸ’‹πŸ’–