RUN_TIPP_TOOL.PY(1)

πŸ“¦ version 1.0, in ubuntu jammy

πŸ’– RUN_TIPP_TOOL.PY β€” bestie edition πŸ’–

okay so real talk, this is run_tipp_tool.py, it lives in section 1 of the manual (User Commands, we love a classic), and it's the little helper script that takes your classification file and turns it into a profile. no cap, that's literally the whole job. it's giving "glorified file converter" but in the best way possible 🫢


✨ NAME ✨

run_tipp_tool.py β€” a helper tool that converts a classification file into a profile. that's it, that's the gig πŸ’…


🌸 DESCRIPTION 🌸

here's how you're supposed to call her:

usage: run_tipp_tool.py [-h] [-g GENE] [-o OUTPUT] [-d OUTPUT_DIR] [-i INPUT] [-t THRESHOLD]

and what does she do? she performs various tools for TIPP. that's the official word. multiple tools. various ones. for TIPP. she's a whole multitasker, main character energy fr fr ✨

πŸŽ€ optional arguments πŸŽ€

  • -h, --help β€” shows this help message and then dips. exit stage left. bye πŸ‘‹
  • -g GENE, --gene GENE β€” use GENE's reference package. tell her which gene's package you want and she'll go get it 🧬
  • -o OUTPUT, --output OUTPUT β€” output files with prefix OUTPUT. [default: output] β€” so if you don't say anything, she's naming everything output, iconic of her honestly
  • -d OUTPUT_DIR, --outdir OUTPUT_DIR β€” output to the OUTPUT_DIR directory. ⚠️ full-path required ⚠️ like, the WHOLE path bestie, don't be shy with it. [default: .] so she'll just vibe in the current directory if you don't tell her otherwise
  • -i INPUT, --input INPUT β€” the input file. ⚠️ full-path required ⚠️ again, full path, no shortcuts. this is the _classification.txt file you get from running run_tipp.py πŸ“
  • -t THRESHOLD, --threshold THRESHOLD β€” threshold for classification. [default: 0.95] β€” she's strict by default, she has standards πŸ’…
side note bestie: -d and -i both want a full path. not a relative one, not a "it's right there in my folder" one. the full one. iykyk 😭

πŸ¦‹ SEE ALSO πŸ¦‹

run_tipp.py(1) β€” yeah, the big sibling. if you haven't run that one yet you probably don't have a _classification.txt to feed this one, so maybe start there bestie 🌈


anyway that's the whole page!! πŸ’œ this one's run_tipp_tool.py, September 2021, that's the version-and-date tea. go forth and convert your classification file into a profile, you absolute legend πŸ‘‘βœ¨πŸ¦‹πŸŽ€πŸ’–

πŸ“¦ where this page comes from