RAPMAP_PSEUDOMAP(1)

πŸ’… RAPMAP_PSEUDOMAP(1) πŸ’…

okay so bestie, welcome to the User Commands section of the manual β€” this is rapmap_pseudomap, section 1, and she's here to serve.


✨ NAME ✨

rapmap_pseudomap β€” the rapmap module that maps reads using a k-mer-based index 🧚


🌸 SYNOPSIS 🌸

,B rapmap pseudomap [-e] [-m <positive integer>] [-t <positive integer>]
[-o <path>] [-r <path>] [-2 <path>] [-1 <path>] [-n] -i <path> [--]
[--version] [-h]

(yes the ,B is right there in the original, we don't question the ancestors πŸ’€)


πŸ¦‹ DESCRIPTION πŸ¦‹

RapMap Mapper

So here's the tea β˜• β€” RapMap is literally a testing ground for ideas in quasi-mapping / (lightweight / pseudo) transcriptome alignment. Which means, at this point in her journey, she is somewhat experimental. Not a red flag exactly but like… a yellow flag 🚩

The develop branch is where all the fresh new improvements and additions live, but it is not guaranteed to be stable between commits. So if you're building on develop, know that. Breaking changes to the master branch will be accompanied by a tag to the version before the breaking change β€” so you can always find your way back home 🫢

Currently, RapMap is a stand-alone quasi-mapper that can be used with other tools. She's also out here being used as part of Sailfish and Salmon β€” multi-hyphenate queen πŸ‘‘

Eventually, the hope is to create and stabilize an API so that it can be used as a library from other tools. The dream ✨


πŸŽ€ OPTIONS πŸŽ€

  • -e, --endCollector β€” use the simpler (and faster) "end" collector instead of the more sophisticated "skipping" collector. Less complicated, more speed, she's efficient πŸ’…
  • -m, --maxNumHits <positive integer> β€” reads that map to more than this many loci get discarded. Too popular? Not in this house 🚫
  • -t, --numThreads <positive integer> β€” how many threads to use. Go off, parallel processing 🌈
  • -o, --output <path> β€” the output file. Default is stdout, so if you say nothing she just talks right at you πŸ—£οΈ
  • -r, --unmatedReads <path> β€” where the single-end reads live 🏠
  • -2, --rightMates <path> β€” where the right paired-end reads live πŸ‘‰
  • -1, --leftMates <path> β€” where the left paired-end reads live πŸ‘ˆ
  • -n, --noOutput β€” don't write out any alignments at all. This exists for speed testing purposes only, so like… don't be surprised when nothing comes out πŸ™ˆ
  • -i, --index <path> β€” (required) the location of the pseudoindex. You literally cannot skip this one, it's giving main character energy and she knows it πŸ‘‘
  • --, --ignore_rest β€” ignores the rest of the labeled arguments following this flag. Everything after this? Not her problem anymore πŸ’€
  • --version β€” displays version information and exits. Quick lil vibe check πŸ“‹
  • -h, --help β€” displays usage information and exits. When in doubt, ask for help bestie 🫢

πŸ’œ AUTHOR πŸ’œ

This manpage was written by Andreas Tille for the Debian distribution and can be used for any other usage of the program. King behavior, we love a contributor πŸ‘


rapmap_pseudomap 0.3.0 Β· September 2016

and that's the whole page bestie, no cap, go map some reads and slay πŸ’–βœ¨πŸ¦‹