KMC_TOOLS-FILTER(1)

πŸ’– KMC_TOOLS-FILTER πŸ’–

okay bestie, welcome to KMC_TOOLS-FILTER(1) β€” that's the section 1 manual page for the kmc_tools-filter command. grab a strawberry πŸ“, we're filtering reads.


✨ NAME ✨

kmc_tools-filter β€” filter out reads with too small number of k-mers 🧚


✨ SYNOPSIS ✨

kmc_tools filter <kmc_input_db> [kmc_input_db_params] <input_read_set>
[input_read_set_params] <output_read_set> [output_read_set_params]

✨ DESCRIPTION ✨

This command filters out reads with too small number of k-mers. that's it, that's the whole vibe. reads that are too k-mer-poor get yeeted πŸ’…


✨ OPTIONS ✨

for the k-mers database, there are additional parameters πŸ—‚οΈ

  • -ci<value> β€” exclude k-mers occurring less than <value> times
  • -cx<value> β€” exclude k-mers occurring more of than <value> times

for the input set of reads, there are additional parameters 🌸

  • -ci<value> β€” remove reads containing less k-mers than value. It can be integer or floating number in range [0.0;1.0]
  • -ci<value> β€” remove reads containing more k-mers than value. It can be integer or floating number in range [0.0;1.0]
not me pointing out that the page lists -ci<value> twice up there β€” yes, literally twice, we're just reporting what it says, no editing from me πŸ™ˆ
  • -f<a/q> β€” input in FASTA format (-fa), FASTQ format (-fq); default: FASTQ

for the output set of reads, there are additional parameters πŸŽ€

  • -f<a/q> β€” output in FASTA format (-fa), FASTQ format (-fq); default: same as input

✨ EXAMPLE ✨

kmc_tools filter kmc_db -ci3 input.fastq -ci0.5 -cx1.0 filtered.fastq
kmc_tools filter kmc_db input.fastq -ci10 -cx100 filtered.fastq

✨ AUTHOR ✨

KMC was originally written by:

  • Sebastian Deorowicz (sebastian.deorowicz@polsl.pl)
  • Marek Kokot
  • Szymon Grabowski
  • Agnieszka Debudaj-Grabysz

the way that's a whole squad of authors πŸ”₯ iconic.


✨ COPYING ✨

KMC is a free software distributed under GNU GPL3 licence for academic, research, and commercial use. periodt. πŸ‘‘


and that's a wrap, bestie 🫢 the footer is literally just KMC_TOOLS-FILTER(1) saying its own name again β€” section 1, same title, no extra date or version info hiding down there. slay, go filter something πŸ’–βœ¨πŸŒˆ

πŸ“¦ where this page comes from