SCRAPPIE(1)

πŸ’– NAME πŸ’–

okay so, introducing scrappie β€” she's a basecaller for the Nanopore sequencer, and she's that girl. 🧬✨


✨ DESCRIPTION ✨

bestie. sit down. let me tell you about Scrappie. 🫢

Scrappie is a technology demonstrator for the Oxford Nanopore Technologies Limited Research Algorithms group. like, it's the research girlies showing off what's possible. no cap. πŸ’…

🌸 Basic usage 🌸

here's the whole menu, so you know what's what:

scrappie events        Base call from event based data.
scrappie help          Print general help or help about specific
                       Scrappie command.
scrappie licence       Print licensing information.
scrappie raw           Base call directly from raw signal.
scrappie version       Print version information.
scrappie squiggle      Create approximate squiggle for sequence
scrappie mappy         Map signal to approximate squiggle
scrappie seqmappy      Map signal to sequence via basecall posteriors
scrappie event_table   Output table of events for read
  • scrappie events β€” base call from event based data πŸŽ€
  • scrappie help β€” print general help, or help about a specific Scrappie command πŸ¦‹
  • scrappie licence β€” print licensing information (the legal tea β˜•)
  • scrappie raw β€” base call directly from raw signal πŸ”₯
  • scrappie version β€” print version information ⭐
  • scrappie squiggle β€” create approximate squiggle for sequence 🌈
  • scrappie mappy β€” map signal to approximate squiggle πŸ—ΊοΈ
  • scrappie seqmappy β€” map signal to sequence via basecall posteriors πŸ’œ
  • scrappie event_table β€” output table of events for read πŸ“‹

πŸŽ€ The lore πŸŽ€

not me about to tell you the origin story, because it's genuinely iconic. 😭

This project began life as a proof (bet) that a base caller could be written in a low level language in under 8 hours. under EIGHT. HOURS. in a low level language. the audacity, the confidence, the main character energy. πŸ‘‘

and listen β€” some of the poor and just plain odd design decisions, along with the lack of documentation, are a result of its inception. yeah. that's the price of the speedrun, bestie. πŸ™ˆ

In keeping with ONT's fish naming policy, the project was originally called Crappie. 🐟 (iykyk.)

⚠️ vibe check before you get attached ⚠️

Scrappie's purpose is to demonstrate the next generation of base calling</> and, as such, may change drastically between releases and breaks backwards compatibility. Newer versions may drop support of current features or change their behaviour. 🚨

so like... do not build your whole life around the current behaviour, fr fr. she's a demonstrator, not a rock. πŸ’€


🫢 AUTHOR 🫢

This manpage was written by Nilesh Patra for the Debian distribution and can be used for any other usage of the program. periodt. πŸ’–


and that's the whole page, bestie! mwah! πŸ’…

scrappie 1.4.2 β€” October 2020 β€” SCRAPPIE(1) 🌸✨