MASKPRIMERS.PY(1)

πŸ’– MASKPRIMERS.PY(1) β€” User Commands πŸ’–

okay bestie, this is the manual page for MASKPRIMERS.PY(1) in the User Commands section, and I'm about to walk you through it 🫢


✨ NAME ✨

okay so MaskPrimers.py is the tool that removes primers and annotates sequences with primer and barcode identifiers πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

here's the usage line, verbatim, so you can copy it straight into your terminal 🌸

usage: MaskPrimers.py [--version] [-h]  ...

the whole vibe is that it removes primers and annotates sequences with primer and barcode identifiers, no cap πŸ”₯

πŸŽ€ help πŸŽ€

  • --version β€” pulls up the program's version number and then bounces πŸ‘‹
  • -h, --help β€” shows the help message and then exits, iconic πŸ’–

🧚 subcommands 🧚

Alignment method is the category these fall under, and here's the lineup πŸ’œ

  • align β€” finds primer matches using pairwise local alignment ✨
  • score β€” finds primer matches by scoring primers at a fixed position 🎯
  • extract β€” removes and annotates a fixed sequence region 🫧

πŸ“ output files πŸ“

  • mask-pass β€” processed reads with successful primer matches, the ones that made it πŸ“
  • mask-fail β€” raw reads that failed primer identification πŸ₯€

🏷️ output annotation fields 🏷️

  • SEQORIENT β€” the orientation of the output sequence. It's either F (input) or RC (reverse complement of input) πŸ”„
  • PRIMER β€” the name of the best primer match πŸ‘‘
  • BARCODE β€” the sequence preceding the primer match. It only shows up when the --barcode flag is specified, so don't forget that flag πŸ™ˆ

πŸ‘‘ AUTHOR πŸ‘‘

Andreas Tille wrote this manpage for the Debian distribution, and it's giving open-source energy: it can be used for any other usage of the program πŸ«ΆπŸ’…


signing off with MaskPrimers.py 0.6.0 from May 2020 πŸ’œβœ¨ stay iconic, bestie πŸŒˆπŸ¦‹