KMA(1)

πŸ’– KMA(1) πŸ’–

User Commands · kma · bestie edition ✨


🌸 NAME 🌸

kma β€” maps and/or aligns raw reads to a template database 🧬✨


πŸ¦‹ DESCRIPTION πŸ¦‹

okay so. KMA-1.3.23 maps and/or aligns raw reads to a template database. that's the whole vibe. it's giving aligner, it's giving mapper, it's giving main character energy πŸ’…

Every option below comes with its Desc (what it does) and its Default (what it does if you say nothing, which is very demure, very mindful of it). scroll, bestie, there's a lot πŸ‘‘

πŸŽ€ Input πŸŽ€

  • -i β€” single end input(s). Default: stdin πŸ“₯
  • -ipe β€” paired end input(s) πŸ‘―
  • -int β€” interleaved input(s) πŸŒ€

🌈 Output 🌈

  • -o β€” output prefix 🏷️
  • -ef β€” output additional features. Default: False
  • -vcf β€” output vcf file, 2 to apply FT. Default: False
  • -sam β€” output sam, 4/2096 for mapped/aligned. Default: False
  • -nc β€” no consensus file. Default: False
  • -nc β€” no aln file. Default: False
  • -nf β€” no frag file. Default: False
  • -matrix β€” output assembly matrix. Default: False
  • -a β€” output all template mappings. Default: False
  • -and β€” use both mrs and p-value on consensus. Default: or
  • -oa β€” use neither mrs or p-value on consensus. Default: False
ngl bestie, -nc really does show up twice in the list β€” once for the consensus file, once for the aln file. it's iconic, it's a two-for-one, we don't question it πŸ™ˆ

πŸ“ Consensus πŸ“

  • -bc β€” minimum support to call bases. Default: 0
  • -bcNano β€” altered indel calling for ONT data. Default: False
  • -bcd β€” minimum depth to cal bases. Default: 1
  • -bcg β€” maintain insignificant gaps. Default: False
  • -ID β€” minimum consensus ID. Default: 1.0%
  • -dense β€” skip insertion in consensus. Default: False
  • -ref_fsa β€” use n's on indels. Default: False

✨ General ✨

  • -t_db β€” template DB πŸ—„οΈ
  • -p β€” p-value. Default: 0.05
  • -shm β€” use DB in shared memory. Default: 0
  • -mmap β€” memory map *.comp.b. Default: False
  • -tmp β€” set directory for temporary files πŸ“
  • -t β€” number of threads. Default: 1 🧡
  • -status β€” extra status. Default: False
  • -verbose β€” extra verbose. Default: False πŸ—£οΈ
  • -c β€” citation πŸ“œ
  • -v β€” version
  • -h β€” shows this help message πŸ†˜

πŸ‘‘ Template mapping πŸ‘‘

  • -ConClave β€” ConClave version. Default: 1
  • -mem_mode β€” base ConClave on template mappings. Default: False
  • -proxi β€” proximity scoring (negative for soft). Default: False/1.0
  • -ex_mode β€” searh kmers exhaustively. Default: False
  • -deCon β€” remove contamination. Default: False 🧼
  • -Sparse β€” only count kmers. Default: False
  • -ss β€” sparse sorting (q,c,d). Default: q
  • -Mt1 β€” map everything to one template. Default: False/0
  • -pm β€” pairing method (p,u,f). Default: u
  • -1t1 β€” one query to one template. Default: False
  • -hmm β€” use a HMM to assign template(s). Default: True
  • -ck β€” count k-mers over pseudo alignment. Default: False

🧚 Chaining 🧚

  • -k β€” k-mersize. Default: DB defined
  • -ts β€” trim front of seeds. Default: 0
  • -ssa β€” seeds soround alignments. Default: False
  • -ex_mode β€” searh kmers exhaustively. Default: False
  • -fpm β€” pairing method (p,u,f). Default: u
  • -mq β€” minimum mapping quality. Default: 0
yes, -ex_mode said what it said up in Template mapping and it's saying it again here. consistent queen πŸ’…

πŸ’œ Alignment πŸ’œ

  • -ca β€” circular alignments. Default: False πŸ”„
  • -mrs β€” minimum relative alignment score. Default: 0.5
  • -mrc β€” minimum query coverage. Default: 0.0
  • -ml β€” minimum alignment length. Default: 16
  • -reward β€” score for match. Default: 1
  • -penalty β€” penalty for mismatch. Default: 2
  • -gapopen β€” penalty for gap opening. Default: 3
  • -gapextend β€” penalty for gap extension. Default: 1
  • -per β€” reward for pairing reads. Default: 7
  • -Npenalty β€” penalty matching N. Default: 0
  • -transition β€” penalty for transition. Default: 2
  • -transversion β€” penalty for transversion. Default: 2
  • -sasm β€” skip alignment. Default: False

πŸŽ€ Trimming πŸŽ€

  • -mp β€” minimum phred score. Default: 20 βœ‚οΈ
  • -eq β€” minimum avg. quality score. Default: 0
  • -5p β€” trim 5 prime. Default: 0
  • -3p β€” trim 3 prime. Default: 0
  • -ml β€” minimum length. Default: 16
  • -xl β€” maximum length on se. Default: 2147483647
  • -boot β€” bootstrap sub-sequence. Default: False
and yes again β€” -ml pulls double duty. 16 for minimum alignment length upstairs, 16 for minimum length right here. same name, different department, both slaying 😭

🌟 Presets 🌟

  • -apm β€” sets both pm and fpm. Default: u
  • -cge β€” set CGE penalties and rewards. Default: False
  • -mint2 β€” set 2ng gen Mintyper preset. Default: False
  • -mint3 β€” set 3rd gen Mintyper preset. Default: False

🫢 AUTHOR 🫢

this manpage was written by Nilesh Patra for the Debian distribution and can be used for any other usage of the program. king behavior honestly πŸ‘‘


kma 1.3.23 Β· July 2021 Β· that's the whole page bestie, thanks for reading, go map some reads πŸ’–βœ¨πŸ¦‹πŸŽ€

πŸ“¦ where this page comes from